Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Project setup #1

Merged
merged 6 commits into from
Nov 2, 2024
Merged

Project setup #1

merged 6 commits into from
Nov 2, 2024

Conversation

penguineer
Copy link
Member

This pull request introduces several significant changes, including the addition of GitHub Actions workflows, Docker configurations, and a new application structure using Tornado. The most important changes are grouped by their themes: CI/CD workflows, Docker setup, application code, and documentation.

CI/CD Workflows

  • Added a GitHub Actions workflow for building and pushing Docker images on push and pull request events. (.github/workflows/docker-image.yml)
  • Added a GitHub Actions workflow for running PyTest on push and pull request events. (.github/workflows/pytest.yml)
  • Added a GitHub Actions workflow for creating releases on tag pushes. (.github/workflows/release.yml)

Docker Setup

  • Created a Dockerfile to build the application using a multi-stage build, including setting up health checks and exposing port 8080. (Dockerfile)
  • Added a docker-compose.yml file for development use, with instructions to create an .env file for configuration. (docker-compose.yml)

Application Code

  • Implemented a new Tornado-based application with health check and OpenAPI specification endpoints. (src/app.py)
  • Added a dummy unit test to set up the testing framework. (test/test_dummy.py)

Documentation

  • Updated the README.md with usage instructions, including how to run the application with Docker and Docker Compose. (README.md)
  • Added a .env.template file for environment variable configuration. (.env.template)

These changes collectively enhance the project's CI/CD pipeline, Docker support, application structure, and documentation.

@penguineer penguineer self-assigned this Nov 2, 2024
@penguineer penguineer merged commit 430b2e8 into main Nov 2, 2024
2 checks passed
@penguineer penguineer deleted the project-setup branch November 2, 2024 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant