Git Product home page Git Product logo

bigfastapi's Introduction

BigFastAPI

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


BigFastAPI Documentation: https://bigfa.st/,

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


Features

Implemented

  • Authentication (login, logout)
  • Users
  • Organizations
  • Comments
  • Blog
  • FAQ
  • Countries
  • Pages
  • Contact
  • Files
  • Notifications
  • Image
  • Wallet
  • PDF Converter
  • Credits
  • Products

In Progress

  • Transactional Email sending + templates
  • Plans
  • Bank Accounts
  • Subscriptions
  • Settings

Planned

  • Currency Rates
  • Marketing Emails
  • Research bank format providers to build on
  • Analytics
  • ActivityLog

How to use BigFastAPI

  • Create a new python project
  • Create a main.py file and set it up as described in the fastapi documentation
  • install the latest version of bigfastapi by running pip install bigfastapi
  • In your main.py, import FastAPI, CORSMiddleware and the create_database function (from bigfastapi.db.database.py). You can look into the bigfastapi main.py to see everything you should import
  • create a .env file and provide all the required environment variables. check check .env.sample file for a sample of what the env should contain
  • Make sure you have a main that calls uvicorn in the bottom of your file
  • You now have access to all the functions in bigfastapi. You can include any of them by importing (from bigfastapi.countries import app as countries) and then including a router app.include_router(countries, tags=["Countries"])
  • Run the main.py file python main.py to start up your server.
  • learn more about how to use bigfastapi at https://bigfa.st/

How to contribute to BigFastAPI

  1. Fork and clone the bigfastapi repository.
  2. Create a virtual environment with python3 -m venv env or python -m venv env
  3. Activate the virtual environment using .\env\Scripts\Activate.ps1 (windows-powershell) or .\env\Scripts\activate.bat (windows-command prompt) or source /path/to/venv/bin/activate (linux/mac)
  4. run pip install -r requirements.txt
  5. Create a .env file by copying the .env.sample file
  6. Run python main.py. Check the code to understand how to use the library
  7. commands for building bigfastapi into a library: python setup.py sdist bdist_wheel
  8. You can install your local version of the library into another project run: pip install <path to local bigfastapi>\dist\<name of whl file>
  9. update on pypi using twine upload --repository-url https://upload.pypi.org/legacy/ dist/* (first install twine using pip install twine)

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.

bigfastapi's People

Contributors

teniolafatunmbi avatar disutoyin avatar blacdev avatar florenceegwu avatar henshaw-knight avatar agughalamdavis avatar austitech avatar mukhtarb avatar cofucan avatar ericogie avatar tmakinde avatar kofimokome avatar johnokwajebi avatar theisrael1 avatar mikoloxtra avatar austinoski avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.