Skip to main content

Simple startapp for fastapi and flask

Project description

StartApp

Simple boilerplate ready for development

MIT licensed GitHub stars GitHub forks GitHub issues Downloads

Notes

  • Currently supported frameworks are: FastApi, Flask

๐Ÿ”จ Installation

 $ sudo pip3 install startapp

๐Ÿ•น Guide

startapp  --help 
  • Type startapp on terminal press enter, questions will promt on terminal choose accroding to your taste.
Right after your choice do the followings accrodingly: 

for fastapi:

source .venv/bin/activate


export settings=dev

pip install -r requirements.txt 

uvicorn app.main:app --reload --port 8007

for flask:

source .venv/bin/activate

pip install -r requirements.txt

export FLASK_APP=app.app

export settings=dev

flask run

Flask Structure

โ”œโ”€โ”€ app
โ”‚ย ย  โ”œโ”€โ”€ controllers
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ app.py
โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ __init__.py
โ”‚ย ย  โ”œโ”€โ”€ __init__.py
โ”‚ย ย  โ”œโ”€โ”€ models
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ __init__.py
โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ models.py
โ”‚ย ย  โ”œโ”€โ”€ serializers
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ __init__.py
โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ serializer.py
โ”‚ย ย  โ””โ”€โ”€ utils.py
โ”œโ”€โ”€ app_init
โ”‚ย ย  โ”œโ”€โ”€ app_factory.py
โ”‚ย ย  โ”œโ”€โ”€ __init__.py
โ”‚ย ย  
โ”‚ย ย      
โ”‚ย ย      
โ”œโ”€โ”€ extensions
โ”‚ย ย  โ”œโ”€โ”€ db_conf.py
โ”‚ย ย  โ”œโ”€โ”€ extension.py
โ”‚ย ย  โ”œโ”€โ”€ __init__.py
โ”‚ย ย  
โ”‚ย ย      
โ”‚ย ย      
โ”œโ”€โ”€ prestart.sh
โ”œ
โ”‚ย ย  
โ”œโ”€โ”€ README.md
โ”œโ”€โ”€ requirements.txt
โ”œโ”€โ”€ server.py
โ”œโ”€โ”€ settings
โ”‚ย ย  โ”œโ”€โ”€ devsettings.py
โ”‚ย ย  โ”œโ”€โ”€ prodsettings.py
โ”‚ย ย  โ”œโ”€โ”€ settings.py
โ”‚ย ย  โ””โ”€โ”€ testsettings.py
โ””โ”€โ”€ tests
    โ”œโ”€โ”€ __init__.py
    โ””โ”€โ”€ test.py

FastApi Structure

โ”œโ”€โ”€ app
โ”‚ย ย  โ”œโ”€โ”€ controllers
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ controller
โ”‚ย ย  โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ controller.py
โ”‚ย ย  โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ schemas.py
โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ __init__.py
โ”‚ย ย  โ”œโ”€โ”€ data
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ __init__.py
โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ models.py
โ”‚ย ย  โ”œโ”€โ”€ __init__.py
โ”‚ย ย  โ”œโ”€โ”€ main.py
โ”‚ย ย  โ””โ”€โ”€ utils
โ”‚ย ย      โ”œโ”€โ”€ helpers.py
โ”‚ย ย      โ””โ”€โ”€ __init__.py
โ”œโ”€โ”€ container.sh
โ”œโ”€โ”€ core
โ”‚ย ย  โ”œโ”€โ”€ dbsetup.py
โ”‚ย ย  โ”œโ”€โ”€ extensions.py
โ”‚ย ย  โ”œโ”€โ”€ factories.py
โ”‚ย ย  โ”œโ”€โ”€ __init__.py
โ”‚ย ย  โ””โ”€โ”€ settings
โ”‚ย ย      โ”œโ”€โ”€ devsettings.py
โ”‚ย ย      โ”œโ”€โ”€ __init__.py
โ”‚ย ย      โ”œโ”€โ”€ prodsettings.py
โ”‚ย ย      โ””โ”€โ”€ settings.py
โ”œโ”€โ”€ Dockerfile
โ”œโ”€โ”€ prestart.sh
โ”œโ”€โ”€ README.md
โ”œโ”€โ”€ req.txt
โ”œโ”€โ”€ requirements.txt
โ””โ”€โ”€ start.sh

Supported OS

Linux, MacOS

๐ŸŒฑ Contributing

Fell free to open issue and send pull request.

startapp supports Python >= 3.6

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

startapp-0.2.0.0.tar.gz (16.3 kB view hashes)

Uploaded source

Built Distribution

startapp-0.2.0.0-py3-none-any.whl (25.2 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page