Spaces:
Running on CPU Upgrade
Running on CPU Upgrade
File size: 1,736 Bytes
61d29fc | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 | # Open Navigator - Documentation Site
This directory contains the **Docusaurus documentation website** for the Open Navigator project.
## Quick Start
```bash
# Install dependencies
npm install
# Start development server
npm start
# Open http://localhost:3000
```
## Available Commands
```bash
npm start # Start development server (localhost:3000)
npm run build # Build static site for production
npm run serve # Serve production build locally
npm run deploy # Deploy to GitHub Pages
npm run clear # Clear Docusaurus cache
```
## Documentation Structure
- `docs/` - All documentation markdown files
- `blog/` - Blog posts (optional)
- `src/pages/` - Custom React pages (home, redirect to app)
- `static/` - Static assets (images, files)
- `docusaurus.config.ts` - Site configuration
- `sidebars.ts` - Documentation sidebar structure
## Integration with Main Project
The documentation site is part of the larger Open Navigator project:
- **Documentation**: `http://localhost:3000` (this site)
- **Open Navigator**: React app at `frontend/` (separate Vite app)
- **API**: FastAPI backend at `api/`
The `/dashboard` page in this site redirects users to the React application.
## Deployment
### Local Testing
```bash
npm run build
npm run serve
```
### GitHub Pages
```bash
GIT_USER=<username> npm run deploy
```
### Integration with Main App
The built static site can be served alongside the FastAPI backend for production.
## Resources
- [Docusaurus Docs](https://docusaurus.io/docs)
- [Main Project README](../README.md)
- [GitHub Repository](https://github.com/getcommunityone/open-navigator-for-engagement)
---
Built with [Docusaurus](https://docusaurus.io/) 🦖
|