StartApp
Simple boilerplate ready for development
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.