Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/albertyw/base-flask
Base Flask/uWSGI/nginx setup
https://github.com/albertyw/base-flask
flask hacktoberfest nginx python python-3 template uwsgi
Last synced: 10 days ago
JSON representation
Base Flask/uWSGI/nginx setup
- Host: GitHub
- URL: https://github.com/albertyw/base-flask
- Owner: albertyw
- License: mit
- Created: 2016-04-03T05:12:15.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-09-27T06:30:56.000Z (about 1 month ago)
- Last Synced: 2024-10-12T05:14:16.610Z (26 days ago)
- Topics: flask, hacktoberfest, nginx, python, python-3, template, uwsgi
- Language: JavaScript
- Homepage:
- Size: 2.65 MB
- Stars: 9
- Watchers: 3
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Base Flask Setup
[](https://drone.albertyw.com/albertyw/base-flask)
[](https://codeclimate.com/github/albertyw/base-flask)
[](https://codeclimate.com/github/albertyw/base-flask/coverage)
[](https://www.varsnap.com/project/bcc034eb-19df-42dc-aa30-8765868f10ec/)
This is a base Flask/Gunicorn/nginx setup, useful as a skeleton for building
simple web apps from. This is meant to be used for websites, as opposed to
pure JSON sites which would be better developed using a different language or
framework (e.g. [sanic](https://github.com/channelcat/sanic)).
Features
--------
- Developed specifically for Python 3
- Minimal but up-to-date python dependencies
- 100% test coverage
- No issues from Code Climate
- PEP8 compliant
- Documented setup and usage procedures
- Includes setting up secure and fast nginx/gunicorn in production
- Docker support
Users
-----
These repositories are based on base-flask:
- [albertyw/albertyw.com](https://github.com/albertyw/albertyw.com)
- [albertyw/pharmadataassociates](https://github.com/albertyw/pharmadataassociates)
- [albertyw/chase-center-calendar](https://github.com/albertyw/chase-center-calendar)
Setup
-----
Modify and run `baseflask/scaffold.sh` to create a copy of base-flask for your
project needs, then run `bin/setup.sh` to set up the host.
Base-flask is designed to work with a minimally sized [AWS EC2](https://aws.amazon.com/ec2/instance-types/)
or [DigitalOcean](https://www.digitalocean.com/pricing/droplets)
instance, running a modern version of Ubuntu or Debian.
### CDN
A CDN like [cloudflare](https://www.cloudflare.com/) can also be added on to boost
speed. A good cloudflare setup would be to use full SSL encryption and to
install an origin certificate so that requests are encrypted end-to-end.
Development
-----------
### Setup
Using [python venv](https://docs.python.org/3/library/venv.html) and
optionally [direnv](https://github.com/direnv/direnv)
```bash
python3.12 -m venv env
printf "source env/bin/activate\nunset PS1\n" > .envrc
direnv allow
pip install -e .[test]
ln -s .env.development .env
npm install
# Install shellcheck
# brew install shellcheck
# sudo apt-get install shellcheck
```
### Spinning up the server:
```bash
npm run build:dev
python app/serve.py
```
### Running tests:
```bash
ruff check .
mypy .
shellcheck --exclude=SC1091 bin/*.sh
coverage run -m unittest discover
npm test
```
### CI/CD
This repo uses:
```bash
# Switch to python 3
pyenv local 3.12
pip install -e .[test]
ln -s .env.development .env
# Test
ruff check .
mypy .
shellcheck --exclude=SC1091 bin/*.sh
coverage run -m unittest discover
coverage report
codeclimate-test-reporter
npm test
# Deployment
ssh example.com website/bin/deploy.sh
```
### Building and starting the docker container
```bash
docker build -t $PROJECT_NAME:test .
docker run -t -i -p 127.0.0.1:$INTERNAL_PORT:5000 $PROJECT_NAME:test
```
Production
----------
### Setup
Run this once on a new server to set up the web app:
```bash
bin/setup.sh
```
### Deployment
Run this every time for a new commit to the repository:
```bash
bin/deploy.sh
```