65 lines
2.2 KiB
Markdown
65 lines
2.2 KiB
Markdown
# AgMission Trunk
|
|
|
|
This is the main development line of the AgMission SaaS platform.
|
|
|
|
## Documentation
|
|
|
|
| Document | Description |
|
|
|---|---|
|
|
| [Documents/ARCHITECTURE.md](Documents/ARCHITECTURE.md) | Software architecture overview — components, data flow, diagrams |
|
|
| [Documents/DEPLOYMENT.md](Documents/DEPLOYMENT.md) | Deployment guide — scripts, PM2, backups, env vars |
|
|
| [Documents/Requirements/Data-Export-API.md](Documents/Requirements/Data-Export-API.md) | Data Export Public API requirements |
|
|
| [Documents/SVN-Guidelines.md](Documents/SVN-Guidelines.md) | SVN branching and commit conventions |
|
|
| [Development/server/docs/DOCUMENTATION_INDEX.md](Development/server/docs/DOCUMENTATION_INDEX.md) | Server-side documentation index |
|
|
| [Development/server/docs/API_SPECIFICATION.md](Development/server/docs/API_SPECIFICATION.md) | REST API reference |
|
|
| [Development/server/docs/PARTNER_INTEGRATION_ARCHITECTURE.md](Development/server/docs/PARTNER_INTEGRATION_ARCHITECTURE.md) | Partner integration (SatLoc) details |
|
|
| [Development/server/docs/DATABASE_DESIGN.md](Development/server/docs/DATABASE_DESIGN.md) | MongoDB schema design |
|
|
| [Development/server/docs/DLQ_INDEX.md](Development/server/docs/DLQ_INDEX.md) | Dead Letter Queue system guide |
|
|
| [Development/server/docs/PAYMENT_FAILURE_HANDLING.md](Development/server/docs/PAYMENT_FAILURE_HANDLING.md) | Billing and payment failure handling |
|
|
| [Development/server/README_PARTNER_INTEGRATION.md](Development/server/README_PARTNER_INTEGRATION.md) | Partner integration quick-start |
|
|
|
|
## Quick Start Development
|
|
|
|
### API Server
|
|
|
|
```bash
|
|
cd Development/server
|
|
cp environment.env.example environment.env # fill in dev values
|
|
npm install
|
|
npm start
|
|
```
|
|
|
|
### Web Client
|
|
|
|
```bash
|
|
cd Development/client
|
|
npm install
|
|
npm start # serves at https://localhost:4200 with SSL proxy
|
|
```
|
|
|
|
### GPS Server AgNav
|
|
|
|
```bash
|
|
cd Development/gps-server
|
|
PROTOCOL=AGNAV node gps-server.js
|
|
```
|
|
|
|
### Track Server
|
|
|
|
```bash
|
|
cd Development/track-server
|
|
node track-server.js
|
|
```
|
|
|
|
## Deployment
|
|
|
|
See [Documents/DEPLOYMENT.md](Documents/DEPLOYMENT.md) for full instructions.
|
|
|
|
Quick deploy from trunk:
|
|
|
|
```bash
|
|
cd trunk/Others/scripts/deploy
|
|
./agm-deploy.sh 1 trunk # backend only
|
|
./agm-deploy.sh 2 trunk # backend + frontend
|
|
```
|