FastyAPI

A FastAPI based Stack boilerplate for heavy loads.
Explore the docs »

View Demo . Donations · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Built with
   • Features
   • Getting Started
   • Environment setup
   • Installation
   • Running and testing
3. Contributing
4. Donations
5. License

About The Project

FastyAPI is a FastAPI based Stack boilerplate designed for large scale workloads and simple developement in mind.

Here's why:

• FastAPI provides such a great developement experience due to its simple structure and the auto generated docs.
• we've improves this further by providing you with a simple design pattern, no subfolders <3
• every Stack element is carefully chosen and tested/optimised against heavy workloads
• boiletplate code for different situations, websocket, crud etc.. yet without bloat.

(back to top)

Built With

Our stack is as follows

• Gunicorn is a Python Web Server Gateway Interface (WSGI) HTTP server. It is a pre-fork worker model
• FastAPI is a Web framework for developing RESTful APIs in Python.
• Celery soon + optional
• Flower soon + optional
• AIOredis asyncio Redis client library.
• Motor presents a coroutine-based API for non-blocking access to MongoDB
• MongoDB is a source-available cross-platform document-oriented database program. Classified as a NoSQL database program, MongoDB uses JSON-like documents with optional schemas.
• Docker soon container is a standard unit of software that packages up code and all its dependencies so the application runs quickly and reliably from one computing environment to another.

(back to top)

Features

• ✔️ Fully done

• ⌛ Needs Tweaks

• [✔️] Auto generated Swagger Documentation

• [✔️] http input validation

• [✔️] MongoDB crud with smart returns

• [✔️⌛] JWT authentication

• [✔️⌛] WebSocket cross-server private and broadcast

• WebSocket http protocols implementation (GET/POST/PATCH/DELETE)

• [⌛] WebSocket json input validation

• Celery and Flower

• Unit testing

• Application and Server health graphs

(back to top)

Getting Started

Set of instructions to get started with FastyAPI

Prerequisites

• Python3
• pip3
• venv

  pip3 install virtualenv

• CentOS preferably
• MongoDB
• Redis

Environment setup

1. Create the project environment directory

   mkdir project_name

2. Create the environment

   cd project_name
   python3 -m virtualenv .

3. Activate the environment

   source bin/activate

Installation

4. Clone the repo

   git clone https://github.com/achaayb/FastyAPI

5. Install the dependencies

   cd FastyAPI 
   pip3 install -r requirements.txt

6. Configure .env to your need
   • better configuration soon
   • please run mongo and redis on your local machine for now

Running and testing

7. run FastyAPI on gunicorn with uvicorn workers

   gunicorn app:app -w 4 -k uvicorn.workers.UvicornWorker --bind 0.0.0.0:5000

8. api test
   • navigate to : http://localhost:5000
   • response should be something like this :

     {"data":"","code":"success","message":"FastyAPI live!"}

9. swaggers docs
   • navigate to : http://localhost:5000/docs
10. websocket test
    • username : http://localhost:5000/static/test1.html
    • username2 : http://localhost:5000/static/test2.html

Minify the boilerplate to your needs

11. soon

(back to top)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Donations

If this project was useful or you believe its interesting, feel free to donate ❤️

Paypal Link : Paypal.me

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Project Link: https://github.com/achaayb/FastyAPI

(back to top)