helix-service-template

Cookiecutter template for creating a new Helix service

Usage

1. Create a new github repo
2. Sync the github repo to your local machine.
3. cd into the folder
4. Install cookiecutter: docker run --rm -it -v $(pwd)/..:/app/ -w /app/ python:3.12 bash -c "mkdir -p cookiecutter; cd cookiecutter; pip install cookiecutter && cookiecutter https://github.com/icanbwell/helix-service-template.git -v -f -o ../"
5. This will ask you for the parameters. Be sure to use your github repo name as the directory name
6. After generation is complete, run make devsetup to set up your environment.
7. If using PyCharm, choose docker-compose as your interpreter and select the "dev" container. Use the Virtualenv Environment option and set the Interpreter as /usr/local/bin/python3
8. Set pytest as the default test runner in PyCharm
9. Run make tests to check that the simple test passes.
10. Run make up to run your new service
11. Inform CISO (@Ross Hosman) to add the repo to Aikido security/vulnerability checks

Automated builds in Github (Continuous Integration)

You will automatically have automated build and test run when you create a PR in github

Automated deployment to AWS ECR (Continuous Deployment)

When you create a release, the docker image will be automatically pushed to AWS ECR.

NOTE: You have to create the image repo one time in AWS ECR