full-stack

(โ˜… 526)

Full stack, modern web application generator. Using Flask, PostgreSQL DB, Docker, Swagger, automatic HTTPS and more.

  • .gitignore
  • .travis.yml
  • cookiecutter.json
  • docker-swarm-cluster-deploy.md
  • LICENSE
  • README.md
  • screenshot.png
  • test.sh
  • testing-config.yml

๐Ÿš€ Installation Guide

1. Get the code
git clone https://github.com/tiangolo/full-stack

Downloads the entire project code from GitHub to your computer.

cd full-stack

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install cookiecutter

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

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
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.
docker compose -f {{cookiecutter.project_slug}}/docker-compose.deploy.build.yml up -d --build

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

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

4. 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 {{cookiecutter.project_slug}}/frontend

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.
// repository documentation