Add minimal README#69
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Code Review
This pull request simplifies the README.md file by replacing the default Next.js boilerplate documentation with concise instructions on how to run and build the BrainDAO UI using pnpm. The feedback suggests expanding the 'Run' section to include steps for setting up environment variables using 'pnpm env:dev' to help developers configure their local environment properly.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| ## Run | ||
|
|
||
| ```bash | ||
| npm run dev | ||
| # or | ||
| yarn dev | ||
| # or | ||
| pnpm install | ||
| pnpm dev | ||
| ``` |
There was a problem hiding this comment.
The project includes scripts to pull environment variables from Vercel (env:dev and env:prod in package.json). It is highly recommended to document this step in the README so that developers know how to set up their local environment before running the development server.
Consider updating the Run section to include this step:
## Run
### 1. Install dependencies
```bash
pnpm install2. Set up environment variables
pnpm env:dev3. Run the development server
pnpm dev
Updates the placeholder or missing README with minimal project info. Branch protection requires this change to go through a PR.