This epic focuses on creating health check endpoints in the Express application, setting up CI/CD with GitHub Actions, and implementing additional features such as GitHub badges, coverage reports, and a Makefile for automation.
Tasks
1. Create health check endpoints in Express
[x] Design and implement health check endpoints in the Express application #8
[x] Health check on third party #36
[x] Test the health check endpoints locally
2. Setup CI/CD with GitHub Actions
[x] Create a GitHub Actions workflow for linting, building, and running tests #9 #33
[x] Configure the workflow to run on pull requests and push events to the main branch
[x] Test the workflow to ensure proper execution
3. Create GitHub badges on README
[x] Add GitHub Actions build status badge to the README.md
[x] Add code coverage badge to the README.md
[x] Add any other relevant badges to the README.md
4. Create coverage reports
[x] Configure Jest to generate code coverage reports
[x] Integrate code coverage reports with the CI/CD pipeline
[x] Add code coverage reports to the GitHub repository
5. Create a Makefile to automate Docker scripts and project initialization
[x] Create a Makefile with commands for common Docker tasks #29
[x] Add commands for project initialization, such as installing dependencies and building the project
[x] Update the README.md with instructions on using the Makefile
Acceptance Criteria
Health check endpoints are implemented and tested in the Express application
CI/CD pipeline is set up with GitHub Actions, including linting, building, and running tests
GitHub badges are added to the README.md
Code coverage reports are generated and integrated with the CI/CD pipeline
A Makefile is created to automate Docker scripts and project initialization tasks
Documentation is updated with relevant information and instructions
This epic focuses on creating health check endpoints in the Express application, setting up CI/CD with GitHub Actions, and implementing additional features such as GitHub badges, coverage reports, and a Makefile for automation.
Tasks
1. Create health check endpoints in Express
2. Setup CI/CD with GitHub Actions
3. Create GitHub badges on README
README.md
README.md
README.md
4. Create coverage reports
5. Create a Makefile to automate Docker scripts and project initialization
Makefile
with commands for common Docker tasks #29README.md
with instructions on using theMakefile
Acceptance Criteria
README.md
Makefile
is created to automate Docker scripts and project initialization tasks