cookiecutter-templete-docker-asteristics

In this repository, we can find template for lauch asteristics apps using cookiecutter properties

cookiecutter-templete-docker-asteristics

This project helps asteristics team to create the that every Elixir API needs at the beginning of the development process.

By using this template you can generate a project directory with the follow:

• README.md: Custom readme with usage instructions
• .gitignore: Custom ignores for elixir development
• Dockerfile: Docker image instructions to release astristics projects
• .dockerignore: Custom docker ignore rules for asteristics projects

Install

You need to install cookiecutter on your local with another testing tools:

$ brew install cookiecutter

Additional you can use yamllint to validate that the generated manifests are valid.

$ brew install yamllint

Usage

Generate a template:

$ cookiecutter git@github.com:resuelve/cookiecutter-templete-docker-asteristics.git

This command will ask you for your project attributes, and after that creates a directory with your project's name, for example:

$ find example-api
example-api
example-api/Dockerfile
example-api/.editorconfig
example-api/README.md
example-api/.dockerignore
example-api/.gitignore

Test resulting yaml

You can use yamllint to lint your resulting Github actions workflow, for example:

$ yamllint example-api/docker-compose.yml

Remember to test locally and fix any error reported by the linter before commit.

Usage for CD workflows

If you wan to build this inside your CI/CD process using Github actions, you can run cookiecutter without user intervention:

$ cd data/vcs
$ cookiecutter git@github.com/resuelve/cookiecutter-templete-docker-asteristics.git \
  --no-input \
  --overwrite-if-exists \
  project_name=example-api

Contributions

I you find this useful please send me a kitty image :P, I'm just kidding, just try to use it and give feedback.

References

Please read the follow references for more details:

• Cookicutter home
• Cookicutter documentation