You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/docs/en/getting-started/development-guide.md
+37-6Lines changed: 37 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,28 +47,57 @@ nexent/
47
47
- Node.js 18+
48
48
- Docker & Docker Compose
49
49
- uv (Python package manager)
50
+
- pnpm (Node.js package manager)
51
+
52
+
### Infrastructure Deployment
53
+
Before starting backend development, you need to deploy infrastructure services. These services include databases, caching, file storage, and other core components.
54
+
55
+
```bash
56
+
cd docker
57
+
./deploy.sh --mode infrastructure
58
+
```
59
+
60
+
::: info Important Notes
61
+
Infrastructure mode will start PostgreSQL, Redis, Elasticsearch, and MinIO services. The deployment script will automatically generate keys and environment variables needed for development and save them to the `.env` file in the root directory. Generated keys include MinIO access keys and Elasticsearch API keys. All service URLs will be configured as localhost addresses for convenient local development.
62
+
:::
50
63
51
64
### Backend Setup
52
65
```bash
53
66
cd backend
54
-
uv sync && uv pip install -e ../sdk
67
+
uv sync --all-extras
68
+
uv pip install ../sdk
55
69
```
56
70
71
+
::: tip Notes
72
+
`--all-extras` will install all optional dependencies, including data processing, testing, and other modules. Then install the local SDK package.
73
+
:::
74
+
57
75
### Frontend Setup
58
76
```bash
59
77
cd frontend
60
-
npm install
61
-
npm run dev
78
+
pnpm install
79
+
pnpm dev
62
80
```
63
81
64
82
### Service Startup
83
+
Before starting services, you need to activate the virtual environment:
Nexent includes three core backend services that need to be started separately:
66
91
```bash
67
-
python backend/data_process_service.py # Data processing service
68
-
python backend/main_service.py # Main service
69
-
python backend/nexent_mcp_service.py # MCP service
92
+
source .env &&python backend/data_process_service.py # Data processing service
93
+
source .env &&python backend/main_service.py # Main service
94
+
source .env &&python backend/nexent_mcp_service.py # MCP service
70
95
```
71
96
97
+
::: warning Important Notes
98
+
All services must be started from the project root directory. Each Python command should be preceded by `source .env` to load environment variables. Ensure infrastructure services (database, Redis, Elasticsearch, MinIO) are started and running properly.
99
+
:::
100
+
72
101
## 🔧 Development Module Guide
73
102
74
103
### 🎨 Frontend Development
@@ -136,6 +165,8 @@ For detailed build instructions, see [Docker Build Guide](../deployment/docker-b
136
165
2.**Code Changes**: Restart related services after code modifications
137
166
3.**Development Mode**: Use debug mode in development environment
138
167
4.**Prompt Testing**: System prompts need thorough testing
168
+
5.**Environment Variables**: Ensure configuration in `.env` file is correct
169
+
6.**Infrastructure**: Ensure infrastructure services are running properly before development
0 commit comments