mirror of
https://github.com/valitydev/erlang-templates.git
synced 2024-11-06 02:25:24 +00:00
da1971c920
* 🔄 Created local '.github/workflows/basic-linters.yml' from remote 'workflows/base/basic-linters.yml' * 🔄 Created local 'LICENSE' from remote 'LICENSE' * 🔄 Created local '.github/settings.yml' from remote '.github/settings.yml' * Fix yamllint concerns * Fix hadolint concerns Co-authored-by: Andrew Mayorov <encube.ul@gmail.com> |
||
---|---|---|
.. | ||
.github/workflows | ||
src | ||
.env | ||
Dockerfile.dev | ||
elvis.config | ||
Makefile | ||
README.md | ||
rebar.config |
{{name}}
{{description}}
Building
To build the project, run the following command:
$ make compile
Running
To enter the Erlang shell with the project running, run the following command:
$ make rebar-shell
Development environment
Run in a docker container
You can run any of the tasks defined in the Makefile from inside of a docker container (defined in Dockerfile.dev
) by prefixing the task name with wc-
. To successfully build the dev container you need Docker BuildKit
enabled. This can be accomplished by either installing docker-buildx locally, or exporting the DOCKER_BUILDKIT=1
environment variable.
Example
- This command will run the
compile
task in a docker container:
$ make wc-compile
Example
- This command will run the
compile
task in a docker container:
$ make wc-compile
Documentation
@TODO Please write a couple of words about what your project does and how it does it.