test

Author: WaDadidou

README.md

@@ -1,6 +1,6 @@
 # Zenao - Zen Autonomous Organizations
 
-An event management and community platform featuring event creation, community management, and social feeds.
+An events management and communities platform featuring event creation, community management, and social feeds.
 
 > **Note:** Zenao is currently a Web2 application, with plans to transition to Web3 using [base](https://www.base.org/).
 
@@ -38,6 +38,7 @@ An event management and community platform featuring event creation, community m
 - **Go 1.25+** ([download](https://go.dev/doc/install))
 
 > **⚠️ Important:** This project uses **Node.js 20.13.1** (see `.nvmrc`), which is not the latest version. Using a different Node version may cause package-lock.json conflicts and CI failures. We strongly recommend using a Node version manager like [nvm](https://github.com/nvm-sh/nvm) or [fnm](https://github.com/Schniz/fnm) to switch to the correct version:
+>
 > ```bash
 > nvm use  # or: fnm use
 > ```
@@ -47,6 +48,7 @@ An event management and community platform featuring event creation, community m
 Follow these steps to run the complete stack locally (frontend + backend + database):
 
 **Before you start:** You may need to configure these services:
+
 - [Clerk Authentication Setup](#clerk-authentication-setup) - If the default test keys have expired
 - [File Uploads with Pinata](#file-uploads-with-pinata) - Required to upload images (e.g., create events)
 
@@ -65,10 +67,12 @@ make dev
 ```
 
 That's it! The app will be running at:
+
 - **Frontend**: [http://localhost:3000](http://localhost:3000)
 - **Backend**: [http://localhost:4242](http://localhost:4242)
 
 > **⚠️ Note:** The Go backend reads environment variables from your shell, not from `.env.local`. Export the Clerk secret key before running `make dev` if you modified the default key:
+>
 > ```bash
 > export ZENAO_CLERK_SECRET_KEY=sk_test_...  # Must match CLERK_SECRET_KEY in .env.local
 > ```
@@ -104,6 +108,7 @@ This creates a `dev.db` file in the project root.
 ### 4. Start Backend
 
 In a dedicated terminal, export the Clerk secret key (if you modified the default) and start the backend:
+
 ```bash
 export ZENAO_CLERK_SECRET_KEY=sk_test_...  # Must match CLERK_SECRET_KEY in .env.local
 go run ./backend start
@@ -112,13 +117,15 @@ go run ./backend start
 The backend will run on http://localhost:4242
 
 **Optional:** Generate fake data for development:
+
 ```bash
 go run ./backend fakegen
 ```
 
 ### 5. Start Frontend
 
 In a new terminal:
+
 ```bash
 npm run dev
 ```
@@ -130,6 +137,7 @@ npm run dev
 - **Database**: `dev.db` (SQLite file in project root)
 
 You can inspect the database using any SQLite client:
+
 ```bash
 sqlite3 dev.db
 # Or use a GUI like DB Browser for SQLite
@@ -191,54 +199,63 @@ DISCORD_TOKEN=                                        # Default: empty (Discord
 ### Unit Tests
 
 Run Go backend tests:
+
 ```bash
 make test
 ```
 
 ### E2E Tests
 
 Run E2E tests in headless mode (automated):
+
 ```bash
 make test-e2e
 ```
 
 Or run manually with the Cypress UI:
 
 **1. Setup environment:**
+
 ```bash
 cp .env.example .env.local
 ```
 
 **2. Start E2E infrastructure:**
+
 ```bash
 go run ./backend e2e-infra
 ```
 
 This command sets up the E2E local environment:
+
 - Applies Atlas migrations on a temporary SQLite DB (`e2e.db`)
 - Generates fake data (users, events, posts, communities, etc.)
 - Starts the backend
 - Exposes `http://localhost:4243/reset` endpoint for test automation (deduplicates/queues concurrent reset requests)
 - Prints logs from all services
 
 **Optional:** Use the `--ci` flag to also build and start the Next.js frontend in the background (used for CI):
+
 ```bash
 go run ./backend e2e-infra --ci
 ```
 
 See `backend/e2e_infra.go` for implementation details.
 
 **3. Wait for stack readiness:**
+
 ```
 READY   | ----------------------------
 ```
 
 **4. Start frontend (new terminal):**
+
 ```bash
 npm run dev
 ```
 
 **5. Open Cypress (new terminal):**
+
 ```bash
 npm run cypress:e2e
 ```
@@ -256,6 +273,7 @@ The project includes default Clerk test keys that work out of the box. If you en
 **2. Create a new application** in the Clerk dashboard
 
 **3. Get your API keys:**
+
 - Dashboard → **API Keys**
 - Copy `NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY` (starts with `pk_test_...`)
 - Copy `CLERK_SECRET_KEY` (starts with `sk_test_...`)
@@ -282,15 +300,18 @@ export ZENAO_CLERK_SECRET_KEY=sk_test_your_key_here
 **1. Create a free Pinata account:** [app.pinata.cloud/register](https://app.pinata.cloud/register)
 
 **2. Create an API Key:**
+
 - Dashboard → **API Keys** → **+ New Key**
 - Grant **Files** write permission and **Group** read permission
 - Copy the JWT (shown only once!)
 
 **3. Create a Gateway:**
+
 - Dashboard → **Gateways** → **+ New Gateway**
 - Copy your gateway domain (e.g., `your-name.mypinata.cloud`)
 
 **4. (Optional) Create a Group:**
+
 - Dashboard → **Groups** → **+ Create Group**
 - Copy the Group ID (used to organize uploaded files)
 
@@ -307,6 +328,7 @@ PINATA_GROUP=your-group-id  # Optional
 ### Common Issues
 
 **Upload fails:**
+
 - Check you haven't exceeded 1GB free tier limit
 - Restart dev server after changing `.env.local`
 
@@ -317,13 +339,15 @@ Zenao supports paid events with Stripe checkout. This feature is behind a featur
 ### Enabling Paid Events
 
 **1. Set the backend feature flag** (as environment variable, not from `.env.local`):
+
 ```bash
 export ZENAO_PAID_EVENTS_ENABLED=true
 ```
 
 > **Note:** The frontend always renders price fields when price groups exist in event data. No frontend flag is needed.
 
 **2. Configure Stripe test keys:**
+
 ```bash
 # In .env.local
 ZENAO_STRIPE_SECRET_KEY=sk_test_your_stripe_test_key
@@ -333,6 +357,7 @@ NEXT_PUBLIC_STRIPE_DASHBOARD_URL=https://dashboard.stripe.com/test
 Get test keys from [Stripe Dashboard → Developers → API keys](https://dashboard.stripe.com/test/apikeys).
 
 **3. (For payment confirmation) Start the Stripe webhook listener:**
+
 ```bash
 # Install the Stripe CLI: https://stripe.com/docs/stripe-cli
 stripe listen --forward-to localhost:4242/webhook/stripe
@@ -372,6 +397,7 @@ make generate
 ```
 
 This will:
+
 - Run protobuf code generation
 - Build email templates
 - Format Go code
@@ -381,11 +407,13 @@ This will:
 **1. Edit GORM models** in `./backend/gzdb` (domain-split files: `db_events.go`, `db_communities.go`, `db_users.go`, `db_tickets.go`, `db_feeds.go`, `db_pricing.go`, `db_roles.go`)
 
 **2. Update Atlas schema:**
+
 ```bash
 make update-schema
 ```
 
 **3. Create migration:**
+
 ```bash
 atlas migrate diff $MIGRATION_NAME \
   --dir "file://migrations" \
@@ -394,11 +422,13 @@ atlas migrate diff $MIGRATION_NAME \
 ```
 
 **4. Apply migration locally:**
+
 ```bash
 make migrate-local
 ```
 
 **5. Apply to staging/production:**
+
 ```bash
 # For staging or prod, set TURSO_TOKEN with a write-enabled token
 export TURSO_TOKEN=<your-token>
@@ -414,11 +444,13 @@ For debugging and tracing requests across the stack, you can run an OpenTelemetr
 ### Quick Start (Recommended)
 
 Start the full stack with OTEL enabled:
+
 ```bash
 make dev-otel
 ```
 
 This starts everything together:
+
 - **Frontend** on [http://localhost:3000](http://localhost:3000)
 - **Backend** on [http://localhost:4242](http://localhost:4242)
 - **OTEL Collector** on port 4318
@@ -427,17 +459,20 @@ This starts everything together:
 ### Manual Setup
 
 **1. Start the OTEL stack:**
+
 ```bash
 docker compose -f dev.docker-compose.yml up
 ```
 
 This starts:
+
 - **OTEL Collector** on port 4318 - receives traces from the app
 - **Jaeger UI** on [http://localhost:16686](http://localhost:16686) - visualize traces
 
 **2. Enable OTEL in your environment:**
 
 Set the OTEL endpoint in `.env.local`:
+
 ```bash
 OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318
 ```
@@ -447,6 +482,7 @@ OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318
 **4. Open Jaeger UI** at [http://localhost:16686](http://localhost:16686) to view request traces.
 
 This is useful for:
+
 - Debugging slow requests
 - Understanding request flow between frontend and backend
 - Performance optimization
@@ -464,6 +500,7 @@ Copy the staging environment variables from your deployment platform's dashboard
 > **Note:** You need to be a team member to access staging environment variables. Contact a team admin if you don't have access.
 
 **2. Start only the frontend:**
+
 ```bash
 npm run dev
 ```
@@ -473,6 +510,7 @@ Now your local frontend will connect to the staging backend and use real staging
 ### Accessing Staging/Production Data
 
 When using staging environment variables:
+
 - You'll see **real user data** from staging
 - Authentication uses the **staging Clerk instance**
 - Any changes affect the **staging database**
@@ -482,27 +520,30 @@ When using staging environment variables:
 ## Troubleshooting
 
 ### Database connection errors
+
 Ensure you've run migrations:
+
 ```bash
 make migrate-local
 ```
 
 ### Cannot access database file
+
 The database is created at `dev.db` in the project root after running `make migrate-local`.
 
 ## Make Commands
 
-| Command | Description |
-|---------|-------------|
-| `make setup-dev` | Install dependencies, configure environment, run migrations, and generate fake data |
-| `make dev` | Start backend and frontend servers together |
-| `make dev-otel` | Start backend, frontend, and OTEL stack (Jaeger UI at localhost:16686) |
-| `make test` | Run Go backend unit tests |
-| `make test-e2e` | Run Cypress E2E tests in headless mode |
-| `make generate` | Regenerate protobuf code and email templates |
-| `make migrate-local` | Apply database migrations to local dev.db |
-| `make update-schema` | Update Atlas schema from GORM models |
-| `make lint-fix` | Run ESLint with auto-fix |
+| Command              | Description                                                                         |
+| -------------------- | ----------------------------------------------------------------------------------- |
+| `make setup-dev`     | Install dependencies, configure environment, run migrations, and generate fake data |
+| `make dev`           | Start backend and frontend servers together                                         |
+| `make dev-otel`      | Start backend, frontend, and OTEL stack (Jaeger UI at localhost:16686)              |
+| `make test`          | Run Go backend unit tests                                                           |
+| `make test-e2e`      | Run Cypress E2E tests in headless mode                                              |
+| `make generate`      | Regenerate protobuf code and email templates                                        |
+| `make migrate-local` | Apply database migrations to local dev.db                                           |
+| `make update-schema` | Update Atlas schema from GORM models                                                |
+| `make lint-fix`      | Run ESLint with auto-fix                                                            |
 
 ## Project Structure