Home

Awesome

StartApp

Simple boilerplate ready for development

MIT licensed GitHub stars GitHub forks GitHub issues Downloads

Notes

šŸ”Ø Installation

 $ sudo pip3 install startapp

šŸ•¹ Guide


startapp  --help 


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