https://github.com/MSAdministrator/docker-flask-template

A docker-compose Flask template
https://github.com/MSAdministrator/docker-flask-template

Last synced: 2 months ago
JSON representation

A docker-compose Flask template

• Host: GitHub
• URL: https://github.com/MSAdministrator/docker-flask-template
• Owner: MSAdministrator
• Created: 2022-01-28T20:02:19.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-29T00:51:59.000Z (almost 3 years ago)
• Last Synced: 2024-11-12T11:44:48.527Z (2 months ago)
• Language: HTML
• Size: 11.7 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• jimsghstars - MSAdministrator/docker-flask-template - A docker-compose Flask template (HTML)

README

        
# Basic Docker Flask Template

This project is a basic `Docker` (and `docker-compose`) Flask project that can be used as a base template.

This project has the following features:

* Bootstrap 4 frontend

* A single container hosting a Flask application

* Utilizes best practices including:

    * Flask application context

    * Flask logging and error handling

    * Flask Blueprints

    * Utilizes a base template inherited within all blueprints

    * Plus more!

> NOTE: This is docker-compose project with only one container

### Prerequisites

To use this project you must download Docker and docker-compose on your local system. You can find more information about how to do that [here](https://docs.docker.com/compose/install/).

### Installing

To get started you must first clone this repository to your local system.

```

git clone https://github.com/MSAdministrator/docker-flask-template.git

cd docker-flask-template

```

Once you have your repository on your system then you can run the following to rebuild and setup your containers:

```

docker-compose up --build --remove-orphans

```

### Structure

All sections of the website should be segmented into blueprints. Each `blueprint` should have the following structure:

```

📦home

 ┣ 📂templates

 ┃ ┗ 📂home

 ┃ ┃ ┣ 📜index.html

 ┃ ┃ ┗ 📜thanks.html

 ┣ 📜__init__.py

 ┣ 📜forms.py

 ┗ 📜views.py

```

Not all modules (single .py files) may be needed. For example not every blueprint will have a `forms.py` or a `models.py` but each blueprint should have a `__init__.py`, a `views.py`, and a `template/{blueprint_name}` folder structure.

## Deployment

Currently there is `NO` production deployment docker-compose file.

## Built With

* [carcass](https://github.com/MSAdministrator/carcass) - Python packaging template

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning

We use [SemVer](http://semver.org/) for versioning. 

## Authors

* Josh Rickard - *Initial work* - [MSAdministrator](https://github.com/MSAdministrator)

See also the list of [contributors](https://github.com/MSAdministrator/attck_viz/contributors) who participated in this project.