docker-flask-example

(β˜… 764)

A production ready example Flask app that's using Docker and Docker Compose.

  • .dockerignore
  • .editorconfig
  • .env.example
  • .gitignore
  • .hadolint.yaml
  • alembic.ini
  • CHANGELOG.md
  • compose.yaml
  • Dockerfile
  • LICENSE
  • pyproject.toml
  • README.md
  • run
  • uv.lock

# Installation Guide

1. Get the code
git clone https://github.com/nickjj/docker-flask-example

Downloads the entire project code from GitHub to your computer.

cd docker-flask-example

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
git clone https://github.com/nickjj/docker-flask-example helloflask

Downloads the entire project code from GitHub to your computer.

docker compose up --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

docker compose down

Runs the command against the services defined in the compose file.

- Log to STDOUT so that Docker can consume and deal with log output

Type this command into your terminal and run it.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd assets

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install .

Installs the package published on PyPI directly β€” no need to clone the source.

python <μ‹€ν–‰ν•  파일λͺ…>.py # READMEμ—μ„œ μ •ν™•ν•œ μ‹€ν–‰ 파일λͺ…을 ν™•μΈν•˜μ„Έμš”

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.
// repository documentation