41 lines
1.1 KiB
Markdown
41 lines
1.1 KiB
Markdown
# REmodel
|
|
|
|
Python calculation engine + FastAPI backend + Next.js frontend for Indian renewable energy (Solar + Wind + BESS) project finance modeling.
|
|
|
|
## Quick start
|
|
|
|
```bash
|
|
# Prerequisites: Python 3.12, Poetry, Node 20, pnpm, Docker
|
|
make setup # install all deps
|
|
make dev # start Redis, API worker, API server, web server
|
|
```
|
|
|
|
## Services (after `make dev`)
|
|
|
|
| Service | URL |
|
|
|-------------|-------------------------|
|
|
| Web UI | http://localhost:3000 |
|
|
| API | http://localhost:8000 |
|
|
| API docs | http://localhost:8000/docs |
|
|
| Redis | localhost:6379 |
|
|
|
|
## Package layout
|
|
|
|
```
|
|
packages/
|
|
├── engine/ pip-installable Python calculation library
|
|
├── api/ FastAPI + Arq async worker
|
|
└── web/ Next.js 14 App Router frontend
|
|
```
|
|
|
|
## Common commands
|
|
|
|
```bash
|
|
make setup # one-time install
|
|
make dev # start all services (requires Docker for Redis)
|
|
make test # pytest + jest
|
|
make lint # ruff + mypy + tsc
|
|
make build # production build
|
|
```
|
|
|
|
See each package's own `README.md` for package-specific commands.
|