Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yash-kavaiya/cloud-run-flask-template

A template for quickly setting up a Flask application for Google Cloud Run deployment. Simplify your Flask projects with this template, providing a structured foundation for deployment on Google Cloud Run. Easy to use, customizable, and well-documented.
https://github.com/yash-kavaiya/cloud-run-flask-template

cloudrun flask google-cloud python shell-script

Last synced: 2 months ago
JSON representation

A template for quickly setting up a Flask application for Google Cloud Run deployment. Simplify your Flask projects with this template, providing a structured foundation for deployment on Google Cloud Run. Easy to use, customizable, and well-documented.

Awesome Lists containing this project

README

        

# Cloud Run Flask Template

[![PyPI version](https://badge.fury.io/py/cloud-run-flask-template.svg)](https://badge.fury.io/py/cloud-run-flask-template)

A template for quickly setting up a Flask application for Google Cloud Run deployment.

## Installation

You can install the Cloud Run Flask Template package using pip:

```bash
pip install cloud-run-flask-template
```
![Image](1.png)
## Usage

To create a new Flask project using this template, follow these steps:

1. Run the following command:

```bash
cloud_run_flask_template
```
![Image](2.png)
2. Navigate to the newly created project directory:

```bash
cd
```
![Image](3.png)
3. Start developing your Flask application within this project structure.

## Project Structure

The project structure generated by the Cloud Run Flask Template is as follows:

```
/
├── main.py
├── requirements.txt
├── templates/
│ └── index.html
└── README.md
```

- `main.py`: Contains the main Flask application code.
- `requirements.txt`: Lists the required Python packages.
- `templates/`: Directory for HTML templates.
- `templates/index.html`: Sample HTML template for the homepage.
- `README.md`: Instructions and information about the project.

## Contributing

Contributions are welcome! Please feel free to open issues or submit pull requests.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
```

You can replace `cloud-run-flask-template` with your actual project name in the Usage section, and customize any other placeholders as needed. This README provides clear instructions on how to install and use your package, as well as an overview of the project structure and information on contributing and licensing.