Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ujstor/web-flask-authen-database
Notes - WebApp in Flask
https://github.com/ujstor/web-flask-authen-database
bootstrap flask python sqlalchemy
Last synced: about 1 month ago
JSON representation
Notes - WebApp in Flask
- Host: GitHub
- URL: https://github.com/ujstor/web-flask-authen-database
- Owner: Ujstor
- Created: 2023-03-30T21:03:33.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-11-05T13:23:20.000Z (about 1 year ago)
- Last Synced: 2023-11-05T14:26:01.783Z (about 1 year ago)
- Topics: bootstrap, flask, python, sqlalchemy
- Language: HTML
- Homepage: https://notes-flask.astipan.com
- Size: 17.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Notes - WebApp in Flask
username: [email protected]
password: vAYAtdqww2Mjjwn
## Running The App
```bash
python main.py
```
## Viewing The App
Go to:
`http://127.0.0.1:5010`
## Docker
To build the Docker image from the code, run:
```
docker compose -f .\docker-compose-dev.yml up
```
If you want to pull the image from the Docker repository instead, use:
```
docker compose -f .\docker-compose-prod.yml up
```
image is automatically built and deployed through the Jenkins pipeline.
Application deployment can be achieved using docker-compose and hosting on the cloud self-hosting service provided by [Collify](https://coolify.io/). An open-source & self-hostable Heroku / Netlify alternative.
# Jenkins Pipeline
This Jenkins pipeline is designed to automate the continuous integration and deployment process. It consists of various stages that are executed based on specific conditions, primarily targeting the `master` branch. Here's a brief overview of the pipeline:
1. **Agent Configuration**: The pipeline is configured to run on any available Jenkins agent.
2. **Environment Variables**: Several environment variables are defined, including the Docker Hub username, Docker repository name, version part (e.g., Patch, Minor, Major), and an empty TAG variable for Docker image tagging.
3. **Stages**:
- **Checkout Code**: This stage fetches the source code from a GitHub repository, specific to the `BRANCH_NAME`.
- **Generate Docker Image Tag**: This stage generates a Docker image tag based on the `BRANCH_NAME` and `VERSION_PART` when the branch is `master`. It executes a shell script and sets the generated tag to the `TAG` environment variable.
- **Build**: When the branch is `master`, this stage builds a Docker image with the previously generated tag.
- **Deploy**: Also targeting the `master` branch, this stage pushes the Docker image to the Docker Hub repository using the tag generated earlier.
- **Environment Cleanup**: This stage cleans up the Docker image with the generated tag after a successful deployment.
4. **Post Actions**: After the pipeline is completed successfully, it prints a success message indicating the successful execution of the pipeline.
This pipeline facilitates the automation of building, tagging, and deploying a Docker image on the `master` branch. It's a part of a CI/CD process, ensuring that code changes are deployed consistently and reliably.