Skip to content

Latest commit

 

History

History
107 lines (84 loc) · 3.84 KB

README.md

File metadata and controls

107 lines (84 loc) · 3.84 KB
Raw

Create-Flask-App PRs Welcome

Flask port of create-react-app that is used for initializing project structure of your next application.

Create Flask app works on macOS, Windows and Linux. If something doesn't work, please file an issue. If you have questions, suggestions or need help, feel free to open an issue.

Quick overview

pip install createflaskapp
create-flask-app my-app
cd my-app
# activate venv
python run.py

(use correct version of pip and python according to your OS and python install) Then open http://localhost:5000 to see your app. When you are ready to deploy to production, set environment variable PRODUCTION to True on your server of choice, clone the project onto your server and spin it up.

Creating an app

You'll need to have Python 3.8 or higher on your local development and server machine. To create a new app, you can run :

bash

create-flask-app my-app

python

python -m create-flask-app my-app

It will create a directory called my-app inside the current folder. Inside that directory, it will generate the initial project structure :

my-app/
├──venv
├── app
│   ├── __init__.py     
│   ├── config.py       
│   ├── errors
│   │   ├── __init__.py 
│   │   └── handlers.py 
│   ├── home
│   │   ├── __init__.py 
│   │   └── routes.py   
│   ├── static
│   │   └── css
│   │       └── main.css
│   └── templates     
│       ├── about.html
│       ├── base.html 
│       ├── error.html
│       └── home.html 
├── requirements.txt  
└── run.py

No complicated configuration or folder structures, only the files you need to build and deploy your app. Once the installation is done, you can open your project folder:

cd my-app

Inside the newly created project, you can run some commands:

source venv/bin/activate or .\venv\Scripts\activate

Activates the virutal environment required for the project dependency isolation.

Read more about venv.

pip install -r requirements.txt

Installs libraries and dependencies listed in requirements.txt in active environment.

python run.py

Starts the app in development mode. Open http://localhost:5000 to view it in browser.

The page will automatically reload if you make changes to the code. You will see errors in app reload or startup in the console.

How to Update to New Versions?

Create-Flask-App can be simply upgraded using pip:

pip install createflaskapp --upgrade
# or
pip install createflaskapp -U

What's Included?

Your environment after installing everything from requirements.txt will have everything you need to build simple but modern Flask app:

  • Isolated Python environment with fully functional pip.
  • Flask, lightweight WSGI web application framework.
  • A live development server that warns about errors and exceptions.
  • Jinja template engine that is very fast and has very similar syntax to python.
  • Click, composable command line interface toolkit.

Check out this guide for an overview of how these tools fit toghether.