kofimokome / bigfastapi-old

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

BigFastAPI

BigFastAPI is an extension of FastAPI that adds a bunch of things that are commonly used in APIs.


BigFastAPI Documentation: ---

FastAPI Documentation: https://fastapi.tiangolo.com


Features

Implemented

  • Authentication (login, logout)
  • Users
  • Organisations
  • Comments
  • Blog
  • FAQ
  • Countries

Planned

  • Transactional Email sending + templates
  • Wallet/Credits
  • Subscriptions & Plans
  • Notifications
  • Plans
  • Blog
  • Countries
  • Contact

How to use it

  1. Upgrade pip with pip install --upgrade pip
  2. Create a virtual environment with python3 -m venv env
  3. Activate the virtual environment using .\env\bin\Activate.ps1 (windows) or source /path/to/venv/bin/activate (linux/mac)
  4. Pull latest code.
  5. run "pip install -r requirements.txt"
  6. Create a .env file by copying the .env.sample file
  7. Run python main.py. Check the code to understand how to use the library
  8. Create your own app in another folder and import the bigfastapi folder

Documentation

When you run the sample code, visit http://127.0.0.1:7001/docs to view the documentation for all endpoints

License

This project is licensed under the terms of the MIT license.

About

License:MIT License


Languages

Language:Python 75.5%Language:HTML 24.5%