Skip to content

Latest commit

 

History

History
87 lines (50 loc) · 2.74 KB

README.md

File metadata and controls

87 lines (50 loc) · 2.74 KB

flask-uwsgi-docker

flask-uwsgi-docker is a template for creating a Flask server utilizing uWSGI and Docker containers. This project simplifies the process of deploying Flask applications, making them ready for development and production environments.

Getting Started

These instructions will help you get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Before you begin, ensure you have the following installed:

  • Docker
  • Docker Compose (optional, for managing multi-container Docker applications)

Installing

Follow these steps to get your development environment running:

  1. Clone the repository

    git clone https://github.com/zaalgol/flask-uwsgi-docker.git
    
  2. Navigate to the project director

    cd flask-uwsgi-docker
    
  3. Build the Docker image

    docker build -t flask-uwsgi-docker .
    
  4. Run the Docker container

    docker run -p 5000:5000 flask-uwsgi-docke

    Alternatively, if you're using Docker Compose to manage multiple containers:

    docker-compose up
    

Accessing the Application

Running the Tests

Explain how to run the automated tests for this system. If you have specific test commands or procedures, include them here.

Deployment

This section would contain additional notes about how to deploy this project on a live system if they differ from the basic installation instructions.

Built With

  • Flask - The web framework used.
  • Docker - Containerization.
  • uWSGI - Application server for serving Python applications.
  • Docker Compose - Used for managing multi-container Docker applications.

Contributing

If you have suggestions for improving the project, please fork the repo and submit a pull request. You can also open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

Versioning

For the versions available, see the tags on this repository.

Authors

  • Zalman Goldstein - Initial work - ZaalGol

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • Hat tip to anyone whose code was used as inspiration.
  • Thanks to the Flask, Docker, and uWSGI communities for their invaluable resources.