Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bittobennichan/flask-quickstart
A minimal boilerplate/template for starting your new Flask project.
https://github.com/bittobennichan/flask-quickstart
boilerplate flask flask-boilerplate flask-template template
Last synced: 5 days ago
JSON representation
A minimal boilerplate/template for starting your new Flask project.
- Host: GitHub
- URL: https://github.com/bittobennichan/flask-quickstart
- Owner: bittobennichan
- License: mit
- Created: 2019-10-15T18:59:11.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-01T21:16:39.000Z (over 1 year ago)
- Last Synced: 2024-12-30T13:36:13.006Z (5 days ago)
- Topics: boilerplate, flask, flask-boilerplate, flask-template, template
- Language: Python
- Homepage:
- Size: 13.7 KB
- Stars: 21
- Watchers: 5
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES
- License: LICENSE
Awesome Lists containing this project
README
# flask-quickstart
**[v1.1.2](https://github.com/bittobennichan/flask-quickstart/blob/master/CHANGES)**
**flask-quickstart** is a minimal boilerplate/template for starting your new Flask project.
The good thing about *flask-quickstart* is that it does not assume that you are using any Flask extensions. It sets up your project layout, main *Blueprint*, configuration and then gets out of your way!
## Quickstart to flask-quickstart
First clone the repostiory
```
$ git clone https://github.com/bittobennichan/flask-quickstart.git
```
Change directory to flask-quickstart
```
$ cd flask-quickstart
```
Create a virtual environment and install dependencies
```
$ python -m venv venv
$ source venv/bin/activate
$ python -m pip install --upgrade pip setuptools
$ python -m pip install -r requirements.txt
```
Start the development server
```
$ python manage.py runserver
```
That's it!
Navigate to `http://127.0.0.1:5000/` and start your new project!
## Project layout
```
flask-quickstart/
├── app/
│ ├── __init__.py
│ ├── main/
│ │ ├── forms.py
│ │ ├── __init__.py
│ │ └── views.py
│ ├── models/
│ ├── static/
│ │ ├── css/
│ │ ├── img/
│ │ └── js/
│ └── templates/
│ ├── common/
│ ├── error/
│ │ ├── 404.html
│ │ └── 500.html
│ └── main/
│ └── index.html
├── CHANGES
├── config.py
├── instance/
│ └── config.py
├── LICENSE
├── manage.py
├── README.md
├── requirements.txt
├── tests/
│ ├── __init__.py
│ └── test_main.py
└── wsgi.py
```
When you clone the repo, you'll notice that you will be missing the *config.py* file in instance folder. You will find an *example_config.py* file instead.
```
├── instance/
└── example_config.py
```
This is b'coz it should be set to be ignored in the *.gitignore* file. Infact everything except *example_config.py* is set to be ignored. This is where you will store the deployment/production configuration values. You don't want to accidently push this to Github. Rename the file to *config.py* after you clone the repo.
If available, the values in `flask-quickstart/instance/config.py` will override any config values set in tthe environment form `flask-quickstart/config.py` when environment is set to `production` (it is set to `development` by default).
The **wsgi.py** file uses `production` as the environment. This file is to be used by WSGI servers such as Gunicorn.
You can also test production environment using `manage.py`
```
$ python manage.py runserver --env production
```
You'll find that there are `.gitkeep` files in some folders. Git does not track empty folders. This is a convention used to preserve the folder structure. These files are not necessary and you can delete them if you want.
## manage.py
As mentioned earlier, **manage.py** has just one command **runserver** which is used to run the Flask development server.
It takes two optional parameters
- `env` - Environment to use while running server. Supports `production`, `development` and `testing` out of the box. Default is `development`.
- `port` - Port to use while running server. Default is 5000.
Eg.
```
$ python manage.py runserver --env production --port 5566
```
Runs the server in `production` environment on port 5566.
You can extend `manage.py` to support additional commands, parameters etc.
## Developing your application
*flask-quickstart* is built in such a way that you can easily integrate extensions, Blueprints, tests etc. The files are commented to help you out with this.