Skip to content

Add minimal README#69

Merged
Royal-lobster merged 1 commit into
mainfrom
codex/minimal-readme
Jun 25, 2026
Merged

Add minimal README#69
Royal-lobster merged 1 commit into
mainfrom
codex/minimal-readme

Conversation

@Royal-lobster

Copy link
Copy Markdown
Member

Updates the placeholder or missing README with minimal project info. Branch protection requires this change to go through a PR.

@vercel

vercel Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
braindao-ui Ready Ready Preview Jun 25, 2026 9:30am

Request Review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md
Comment on lines +5 to 10
## Run

```bash
npm run dev
# or
yarn dev
# or
pnpm install
pnpm dev
```

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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 install

2. Set up environment variables

pnpm env:dev

3. Run the development server

pnpm dev

@Royal-lobster
Royal-lobster merged commit b948068 into main Jun 25, 2026
2 checks passed
@Royal-lobster
Royal-lobster deleted the codex/minimal-readme branch June 25, 2026 09:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant