https://github.com/koldakov/futuramaapi
Futurama inspired REST and GraphQL API, blending characters exploration with real-time updates. Tech playground featuring FastAPI, Docker, and more!
https://github.com/koldakov/futuramaapi
alembic async babel fastapi graphql http2 hypercorn mypy pydantic pydantic-v2 python ruff sqlalchemy sqlalchemy-python sse strawberry strawberry-graphql
Last synced: 2 days ago
JSON representation
Futurama inspired REST and GraphQL API, blending characters exploration with real-time updates. Tech playground featuring FastAPI, Docker, and more!
- Host: GitHub
- URL: https://github.com/koldakov/futuramaapi
- Owner: koldakov
- License: apache-2.0
- Created: 2023-11-30T18:23:55.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-11-05T20:38:52.000Z (about 2 months ago)
- Last Synced: 2025-11-05T21:30:43.046Z (about 2 months ago)
- Topics: alembic, async, babel, fastapi, graphql, http2, hypercorn, mypy, pydantic, pydantic-v2, python, ruff, sqlalchemy, sqlalchemy-python, sse, strawberry, strawberry-graphql
- Language: Python
- Homepage: https://futuramaapi.com
- Size: 11.4 MB
- Stars: 208
- Watchers: 3
- Forks: 15
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-fastapi - FuturamaAPI - A REST and GraphQL playground built with best practices, providing WebSockets, SSE, callbacks, secret messages, and more. (Projects / Open Source Projects)
README
# About The Project
Welcome to Futuramaapi – your go-to platform for diving into the realms of REST and GraphQL technologies.
More than just a learning space, this project is a dynamic hub for anyone keen on mastering RESTful API design,
crafting GraphQL queries, and exploring related technologies.
But we're not just another tutorial. Futuramaapi doubles as a sandbox,
inviting you to play with the latest tools and frameworks.
It's not about theory; it's about hands-on experience, transforming what you learn into practical skills.
Join a vibrant community, engage in experimentation, and collaborate with fellow enthusiasts.
Whether you're a beginner or a seasoned developer, Futuramaapi is your space for continuous learning and innovation.
Explore the future of API mastery with Futuramaapi – where learning meets experimentation.
Join us in shaping the future of technology.
## Key Features
### RESTful API:
Explore and understand the principles of REST through our comprehensive API implementation.
### GraphQL Integration:
Dive into the world of GraphQL with seamless integration and interactive examples.
### Server-Sent Events (SSE):
Experience real-time updates and notifications through the power of Server-Sent Events.
### OpenAPI Documentation:
Easily navigate and interact with our APIs using OpenAPI documentation.
### Technologies:
Built with HTTP/2, Hypercorn, Python 3.12, FastAPI, asynchronous programming, SQLAlchemy, alembic,
PostgreSQL, CI/CD, Ruff, and more,
this project embraces cutting-edge technologies to provide a modern development experience.
## Requirements
1. Python >= 3.12
2. PostgreSQL
3. poetry
## Installation
```commandline
# Clone repo
git clone git@github.com:koldakov/futuramaapi.git
# Instal dependencies
poetry install
# Initiate pre-commit
poetry run pre-commit install
```
## Migrations
If you create models in a new file please import it in env.py.
Because alembic does not detect child classes.
```commandline
poetry run alembic revision --autogenerate -m "Revision Name"
poetry run alembic upgrade head
```
## Development
```commandline
# Export variables
export $(cat .env | xargs)
# Run server
bash docker-entrypoint.sh
```
## Contributing
1. Fork the Project
2. Open a Pull Request
3. Or just read here: [contributing](https://docs.github.com/en/get-started/quickstart/contributing-to-projects)
## Methodology
1. Do a lot, break a lot.
2. There are no difficult tasks, only interesting.
3. Mostly TBD.
## Important
1. Quality.
2. Security.
3. Google first.
## License
Distributed under the Apache 2.0 License. See [LICENSE.md](LICENSE.md) for more information.
## Buy me a coffee if you want to support me
https://www.buymeacoffee.com/aivCoffee
## Contact
Hi all,
How are you? Hope You've enjoyed the project.
There are my contacts:
- [Linkedin](https://www.linkedin.com/in/aiv/)
- [Send an Email](mailto:coldie322@gmail.com?subject=[GitHub]-qworpa)
Project Link: https://github.com/koldakov/futuramaapi
Best regards,
[Ivan Koldakov](https://www.linkedin.com/in/aiv/)