-
-
Notifications
You must be signed in to change notification settings - Fork 15
Development Setup
Jaeseok Song edited this page Jan 13, 2026
·
2 revisions
Follow these instructions to set up a local development environment.
- Rust: Install via rustup.
- Node.js & npm: For the frontend.
- SQLite3: For the database.
- Certbot: (Optional) Required for testing SSL generation locally.
-
/backend: Rust source code. -
/frontend: React source code. -
/data: Default directory for database and certificates (ignored by git).
- Navigate to the backend directory:
cd backend - Create a
.envfile (optional, defaults are used):JWT_SECRET=dev_secret RUST_LOG=debug
- Run the backend:
The backend will listen on:
cargo run
-
0.0.0.0:81for API/Dashboard. -
0.0.0.0:8080for HTTP Proxy.
-
- Navigate to the frontend directory:
cd frontend - Install dependencies:
npm install
- Run the development server:
npm run dev
- Access the dashboard at
http://localhost:5173. The Vite dev server is configured to proxy/apirequests tolocalhost:81.
cd backend
cargo testdocker compose -f docker-compose.dev.yml up --build-
Database: You can use any SQLite browser to inspect
data/data.db. -
Logs: Backend logs are printed to stdout and also saved in
logs/. - Pingora: Note that Pingora might require specific permissions to bind to low ports (like 443). For local dev, we use 8080.
Next: API Documentation