This is FastAPI project, which is a simple voting system. It allows to create polls, vote for options and see results.
Clone the repository using:
git clone https://github.com/lilpuzeen/VoteSystem.gitUse the package manager pip to install dependencies from pyproject.toml file:
python -m pip install .Soon, project will be deployed to Heroku/Render, so you can use it without installation.
This project provides a simple RESTful API for creating and participating in various surveys. You can create your own survey, add any questions to it and specify answer options for them.
To start the project, run the following command:
uvicorn src.main:app --reloadThen go to http://localhost:8000/docs to see the documentation and try the API.
The project is structured as follows:
├── VoteSystem
│ ├── .github (contains github actions such as linters, in future will contain CI/CD pipeline)
│ ├── alembic (contains database migrations)
│ ├── src
│ │ ├── actions (contains actions for working with polls and questions)
│ │ ├── auth (contains authentication and authorization, made with JWT and fastapi_users)
│ │ ├── polls (contains polls and questions models, routers and services)
│ │ ├── config.py (contains project settings such as secret key, database url, etc.)
│ │ ├── database.py (contains database connection)
│ │ ├── main.py (contains FastAPI app and routers)
│ ├── docs (contains project documentation, mkdocs will be used in future to generate documentation)
│ ├── tests (still in development)
│ ├── Dockerfile/docker-compose.yml (still in development)
│ ├── etc.
- Finalize some CRUD endpoints
- Add tests with pytest (unit, integration, e2e)
- Add aioredis for caching
- Slowapi for rate limiting
- Celery for background tasks (i.e. sending emails)
- Add mkdocs for documentation generation and deploy it to github pages
- Optional: add CORS middleware for frontend and deploy project to AWS EC2 / Lightsail / Beanstalk
- Optional: AWS CloudFront for CDN
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
This project will be updated and improved. In the near future it will be possible to work with classes, exceptions, context managers, async and other features.