https://github.com/MaanasArora/polis-ctto
https://github.com/MaanasArora/polis-ctto
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/MaanasArora/polis-ctto
- Owner: MaanasArora
- License: mit
- Created: 2024-11-27T11:28:53.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2025-04-15T21:26:34.000Z (2 months ago)
- Last Synced: 2025-04-15T22:27:37.648Z (2 months ago)
- Language: Python
- Size: 181 KB
- Stars: 5
- Watchers: 1
- Forks: 3
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-polis - MaanasArora/polis-ctto - A simple and efficient polis-like system built as a learning exercise by a contributor from Civic Tech Toronto. (Misc)
README
This is an open-source web application implementing a Polis-like algorithm.
## Installation
### Web API
The web API is written in [FastAPI](https://fastapi.tiangolo.com/), a web framework for Python. You need to install Python before running the API.
Installation for Windows (instructions are minimally changed for Linux):
```bash
cd polis.server
python -m venv venv
venv/Scripts/activate # (in Linux, use source venv/bin/activate)
pip install -r requirements.txt
```
To run the API (in auto-reload mode):
```bash
uvicorn polis.main:app --reload
```
### Frontend
The frontend requires [https://nodejs.org/en](https://nodejs.org/en) to run and is written in [Vite](https://vite.dev/).
Installation using Node (Windows and Linux):
```bash
cd polis.client
npm install
```
To run the frontend (in development mode):
```
npm run dev
```