Awesome
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.