Skip to content

Commit ae44dd4

Browse files
committed
docs: add Makefile, update README with run commands, fix community refs
- Add Makefile with setup, dev, build, lint, and clean targets - Update README Quick Start to use make commands with full command table - Update CONTRIBUTING.md dev setup to reference Makefile - Fix CODE_OF_CONDUCT.md to reference CopilotKit community consistently
1 parent b2fc1d0 commit ae44dd4

4 files changed

Lines changed: 89 additions & 23 deletions

File tree

CODE_OF_CONDUCT.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Open Generative UI is an open-source showcase and template for building rich, in
2222

2323
## 2. Community Values
2424

25-
At Open Generative UI and across the CopilotKit ecosystem, we prioritize the following values:
25+
At CopilotKit, we prioritize the following values:
2626

2727
| **Value** | **Description** |
2828
| ----------------- | ---------------------------------------------------------------------------------------------------------- |
@@ -35,7 +35,7 @@ At Open Generative UI and across the CopilotKit ecosystem, we prioritize the fol
3535

3636
## 3. Expected Behavior
3737

38-
As a participant in the Open Generative UI community, you are expected to:
38+
As a participant in the CopilotKit community, you are expected to:
3939

4040
- **Be Respectful and Inclusive**: Treat all individuals with respect and kindness, regardless of their background, identity, or experience level.
4141
- **Communicate Constructively**: Engage in discussions that are constructive, focusing on ideas and solutions rather than personal opinions.
@@ -94,7 +94,7 @@ Consequences for violating the Code of Conduct will be determined based on the s
9494

9595
## 7. Scope
9696

97-
This Code of Conduct applies to all participants in the Open Generative UI community, including contributors, maintainers, and users, both online and offline. It encompasses interactions in the following areas:
97+
This Code of Conduct applies to all participants in the CopilotKit community, including contributors, maintainers, and users, both online and offline. It encompasses interactions in the following areas:
9898

9999
- GitHub discussions and issues on the [open-generative-ui](https://github.com/CopilotKit/open-generative-ui) repository
100100
- The broader [CopilotKit Discord](https://discord.gg/6dffbvGU3D)

CONTRIBUTING.md

Lines changed: 31 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -49,36 +49,55 @@ This is a **Turborepo monorepo** with a Next.js frontend and a LangGraph Python
4949

5050
> **Windows users:** Enable **Developer Mode** (Settings > System > For developers > Developer Mode → On) to allow symlink creation. This is required for Next.js standalone builds and pnpm to work correctly.
5151
52-
### 2) Install Dependencies
52+
### 2) Install Dependencies and Set Up
53+
54+
The quickest way to get started is with the Makefile:
5355

5456
```bash
55-
pnpm install
57+
make setup # Installs deps + creates .env template
5658
```
5759

58-
### 3) Set Up Environment Variables
60+
Or manually:
5961

6062
```bash
61-
# Add your OpenAI API key for the agent
63+
pnpm install
6264
echo 'OPENAI_API_KEY=your-key-here' > apps/agent/.env
6365
```
6466

65-
### 4) Start Development
67+
Then add your real OpenAI API key to `apps/agent/.env`.
68+
69+
### 3) Run the Project
70+
71+
```bash
72+
make dev # Start all services (frontend + agent + mcp)
73+
```
74+
75+
Or run services individually:
6676

6777
```bash
68-
# Start all services (frontend + agent)
69-
pnpm dev
78+
make dev-app # Next.js frontend on http://localhost:3000
79+
make dev-agent # LangGraph agent on http://localhost:8123
80+
make dev-mcp # MCP server
81+
```
7082

71-
# Or start individually:
72-
pnpm dev:app # Next.js frontend on http://localhost:3000
73-
pnpm dev:agent # LangGraph agent on http://localhost:8123
83+
You can also use `pnpm` directly:
84+
85+
```bash
86+
pnpm dev # All services
87+
pnpm dev:app # Frontend only
88+
pnpm dev:agent # Agent only
7489
```
7590

76-
### 5) Build
91+
### 4) Build and Lint
7792

7893
```bash
79-
pnpm build
94+
make build # Build all apps
95+
make lint # Lint all apps
96+
make clean # Clean build artifacts
8097
```
8198

99+
Run `make help` to see all available commands.
100+
82101
## Step 4: Create a branch
83102

84103
Create a new branch for your changes.

Makefile

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
.PHONY: help install setup dev dev-app dev-agent dev-mcp build lint clean
2+
3+
help: ## Show this help message
4+
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-15s\033[0m %s\n", $$1, $$2}'
5+
6+
install: ## Install all dependencies (Node + Python)
7+
pnpm install
8+
9+
setup: install ## Full setup: install deps and create .env from template
10+
@if [ ! -f apps/agent/.env ]; then \
11+
echo "OPENAI_API_KEY=your-key-here" > apps/agent/.env; \
12+
echo "Created apps/agent/.env — add your OpenAI API key"; \
13+
else \
14+
echo "apps/agent/.env already exists, skipping"; \
15+
fi
16+
17+
dev: ## Start all services (frontend + agent + mcp)
18+
pnpm dev
19+
20+
dev-app: ## Start Next.js frontend only (http://localhost:3000)
21+
pnpm dev:app
22+
23+
dev-agent: ## Start LangGraph agent only (http://localhost:8123)
24+
pnpm dev:agent
25+
26+
dev-mcp: ## Start MCP server only
27+
pnpm dev:mcp
28+
29+
build: ## Build all apps
30+
pnpm build
31+
32+
lint: ## Lint all apps
33+
pnpm lint
34+
35+
clean: ## Clean build artifacts
36+
pnpm clean

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,30 @@ All visuals are rendered in sandboxed iframes with automatic light/dark theming,
1818
## Quick Start
1919

2020
```bash
21-
# Install dependencies
22-
pnpm install
23-
24-
# Add your OpenAI API key
25-
echo 'OPENAI_API_KEY=your-key' > apps/agent/.env
26-
27-
# Start all services
28-
pnpm dev
21+
make setup # Install deps + create .env template
22+
# Edit apps/agent/.env with your real OpenAI API key
23+
make dev # Start all services
2924
```
3025

3126
- **App**: http://localhost:3000
3227
- **Agent**: http://localhost:8123
3328

29+
### Available Commands
30+
31+
| Command | Description |
32+
|---------|-------------|
33+
| `make setup` | Install all dependencies and create `.env` template |
34+
| `make dev` | Start all services (frontend + agent + mcp) |
35+
| `make dev-app` | Start Next.js frontend only |
36+
| `make dev-agent` | Start LangGraph agent only |
37+
| `make dev-mcp` | Start MCP server only |
38+
| `make build` | Build all apps |
39+
| `make lint` | Lint all apps |
40+
| `make clean` | Clean build artifacts |
41+
| `make help` | Show all available commands |
42+
43+
You can also use `pnpm` directly (`pnpm dev`, `pnpm dev:app`, `pnpm dev:agent`, etc.).
44+
3445
## Architecture
3546

3647
Turborepo monorepo with two apps:

0 commit comments

Comments
 (0)