Overview

This project is a simple Flask application that serves as a template for building web applications. It includes a basic structure with Docker support for easy deployment and development.

🔧 Prerequisites

Before you start, make sure you have the following installed:

  • Docker
  • Docker Compose

📜 Instructions

Usage:

bash cmd.sh {start|stop|setup|clear|build|deploy}

setup

If you haven't built the project yet, you can do so by running:

bash cmd.sh setup

To run in detached mode, use:

bash cmd.sh setup -d

Once the setup process is complete, the project will be accessible at localhost:8000.

If this port is already in use, search for all occurrences of 8000 within the project and replace them with your preferred port number. After making these changes, you'll need to rebuild the project for the modifications to take effect.

start

The program will run in debug mode, meaning frontend changes will be rendered upon reload. However, if you make changes to the backend, you will need to restart the program by running:

bash cmd.sh start

To run in detached mode, use:

bash cmd.sh start -d

stop

To stop the program, simply run:

bash cmd.sh stop

For a quicker way to stop, use ctrl + C to force stop the program.

clear

If you need to clear all containers and their orphaned dependencies, you can run:

bash cmd.sh clear

build

To generate the static files for the project, run the following command:

bash cmd.sh build

After the build process completes, the static files will be available in the ./app/build directory.

deploy

To deploy the application to production, you can use the following command:

bash cmd.sh deploy

This project leverages GitHub Actions for CI/CD. The deployment workflow is configured to automatically build the project and deploy it to the GitHub Pages environment.

🔥 Ready to Start?

Feel free to clone the project, explore the code, and build something amazing with it! If you have any suggestions or improvements, feel free to submit a pull request.

GitHub logo robertovicario / FlaskApp

Get your Flask app up and running in seconds.

FlaskApp

Overview

This project is a simple Flask application that serves as a template for building web applications. It includes a basic structure with Docker support for easy deployment and development.

Prerequisites

Important

  • Docker
  • Docker Compose

User Interface (UI)












UI
Home - FlaskApp

Instructions

Usage:

bash cmd.sh {start|stop|setup|clear|build|deploy}
Enter fullscreen mode Exit fullscreen mode

setup

If you haven't built the project yet, you can do so by running:

bash cmd.sh setup
Enter fullscreen mode Exit fullscreen mode

To run in detached mode, use:

bash cmd.sh setup -d
Enter fullscreen mode Exit fullscreen mode

Once the setup process is complete, the project will be accessible at localhost:8000.

Warning

If this port is already in use, search for all occurrences of 8000 within the project and replace them with your preferred port number. After making these changes, you'll need to rebuild the project for the modifications to take effect.

start

The program will run in debug mode, meaning frontend changes…


View on GitHub


⭐ Support the Project
If you find this template useful, don't forget to give it a STAR on GitHub! It helps a lot!