Merge pull request #85 from MD1125/documentation

Improve Documentation, Harden Build Scripts, and Enhance Number Formatting

README.md

@@ -18,33 +18,174 @@ Rugplay is a realistic cryptocurrency trading simulator that lets you experience
 ![Preview 2](github_assets/preview2.png)
 ![Preview](github_assets/preview.png)
 
-## Setup
+## Development Setup
 
-1. Copy the environment file:
+### Prerequisites
 
-    ```bash
-    cp website/.env.example website/.env
-    ```
+Before you begin, make sure you have the following installed:
 
-2. Edit `website/.env` with your actual values.
+- [Node.js](https://nodejs.org/) (LTS version recommended)
+- [Bun](https://bun.sh/) (for websocket server)
+- [Docker](https://www.docker.com/) (for running Redis and PostgreSQL)
 
-3. Start with Docker (recommended):
+### Getting Started
+
+1. **Clone the repository**
+
+   ```bash
+   git clone https://github.com/outpoot/rugplay.git
+   cd rugplay
+   ```
+
+2. **Set up Redis**
+
+   Create a Redis Docker container:
+   ```bash
+   docker run -d --name rugplay-redis -p 6379:6379 -v rugplay_redisdata:/data --restart unless-stopped redis:8-alpine redis-server --save 60 1
+   ```
+
+   **Alternative:** You can also [download and install Redis directly](https://redis.io/downloads/) for your operating system, or use a managed Redis service such as Redis Cloud.
+
+3. **Set up PostgreSQL**
+
+   You have two main options for your Postgres database:
+
+   - **Run Postgres locally with Docker:**
+     ```bash
+     docker run -d --name rugplay-postgres -e POSTGRES_USER=pguser -e POSTGRES_PASSWORD=pgpass -e POSTGRES_DB=rugplay -p 5432:5432 -v rugplay_pgdata:/var/lib/postgresql/data --restart unless-stopped pgvector/pgvector:pg16
+     ```
+
+   - **Use a managed cloud Postgres provider:**
+     Services like [Supabase](https://supabase.com/), [Neon](https://neon.tech/), or others let you create a Postgres database online, often with a free tier. Simply grab your connection details (host, user, password, database name) from your provider.
+
+   After your database is running, update your `DATABASE_URL` in the `.env` file to point to your Postgres instance.
+
+   If you are running Postgres locally, you can seed the database with:
+   ```bash
+   docker exec -it rugplay-postgres psql -d rugplay -U pguser
+   ```
+   Then, copy and paste the SQL from the migration files (e.g. `website/drizzle/0000_crazy_bloodstrike.sql`).
+
+4. **Configure Google OAuth**
+
+   - Go to [Google Auth Platform dashboard](https://console.cloud.google.com/auth/clients)
+   - Create a new client:
+     - Application type: "Web application"
+     - Name: Your choice
+     - Authorized JavaScript origins: Can be left empty
+     - Authorized redirect URIs:
+       - http://localhost:3002/api/auth/callback/google
+       - http://localhost:5173/api/auth/callback/google
+       - Production URL
+
+5. **Configure Environment Variables**
+
+   ```bash
+   cd website
+   cp .env.example .env
+   ```
+
+   Edit `.env` with your values. Example:
+
+   ```ini
+   # --- Database ---
+   DATABASE_URL=postgres://pguser:pgpass@localhost:5432/rugplay   # PostgreSQL connection string
+   POSTGRES_USER=pguser      # PostgreSQL username (should match Docker config)
+   POSTGRES_PASSWORD=pgpass  # PostgreSQL password (should match Docker config)
+   POSTGRES_DB=rugplay       # PostgreSQL database name (should match Docker config)
+
+   # --- Redis ---
+   REDIS_URL=redis://localhost:6379  # Redis connection string
+
+   # --- Auth ---
+   PRIVATE_BETTER_AUTH_SECRET=your_secret_here   # Any alphanumeric string for session encryption
+   PUBLIC_BETTER_AUTH_URL=http://localhost:5173  # For development, use http://localhost:5173. For production, use http://localhost:3002
+
+   # --- Google OAuth ---
+   GOOGLE_CLIENT_ID=your_google_client_id
+   GOOGLE_CLIENT_SECRET=your_google_client_secret
+
+   # --- Websocket ---
+   PUBLIC_WEBSOCKET_URL=ws://localhost:8080      # URL of the websocket server
+
+   # --- Optional: AWS (for additional features) ---
+   AWS_ACCESS_KEY_ID=your_aws_access_key
+   AWS_SECRET_ACCESS_KEY=your_aws_secret_key
+   AWS_REGION=us-east-1
+
+   # --- Optional: OpenRouter (for AI features) ---
+   OPENROUTER_API_KEY=your_openrouter_api_key
+   ```
+
+   **Notes:**
+   - For production, change `PUBLIC_BETTER_AUTH_URL` to `http://localhost:3002` or your deployed domain.
+   - The `DATABASE_URL` should match your Postgres Docker container settings.
+   - The `REDIS_URL` should match your Redis Docker container settings.
+   - AWS and OpenRouter variables are optional and only needed for advanced features.
+
+6. **Install Dependencies**
+
+   Set up the websocket server:
+   ```bash
+   cd website/websocket
+   bun install
+   ```
+
+   Set up the main website:
+   ```bash
+   cd ../
+   npm install --include=dev
+   ```
+
+### Running the Application
+
+1. **Start the websocket server**
+
+   ```bash
+   cd website/websocket
+   bun run src/main.ts
+   ```
+
+2. **Start the main website (Development Mode)**
+
+   In a new terminal:
+   ```bash
+   cd website
+   npm run dev
+   ```
+
+   The development server will be available at http://localhost:5173
+
+### Production Deployment
+
+#### Using Docker (Recommended)
+
+1. **Build and start with Docker:**
 
     ```bash
     ./build.sh
     ```
 
-4. The app will be available at http://localhost:3002
+    This will automatically start all required services, including the Database, Redis and the websocket server, as Docker containers. You do not need to run the websocket server manually when using Docker Compose for deployment.
 
-## Development
+2. The app will be available at http://localhost:3002
 
-```bash
-cd website
-npm install
-npm run dev
-```
+#### Manual Deployment
 
-The development server runs on http://localhost:5173
+1. **Build the website:**
+
+    ```bash
+    cd website
+    npm run build
+    npm run preview
+    ```
+
+2. **Start the websocket server:**
+
+    ```bash
+    cd website/websocket
+    bun run src/main.ts
+    ```
 
 ## License