erlang-templates/library-templates
Vality Bot da1971c920
🔄 Synced file(s) with valitydev/configurations (#11)
* 🔄 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>
2022-04-04 19:00:06 +03:00
..
.github/workflows Add a couple of fixes (#6) 2022-03-17 12:03:39 +03:00
src ED-227/feat/service monitoring (#24) 2021-11-16 12:37:55 +03:00
.env TD-47: Update templates (#1) 2022-02-02 12:15:10 +03:00
Dockerfile.dev 🔄 Synced file(s) with valitydev/configurations (#11) 2022-04-04 19:00:06 +03:00
elvis.config Add a couple of fixes (#6) 2022-03-17 12:03:39 +03:00
Makefile Add a couple of fixes (#6) 2022-03-17 12:03:39 +03:00
README.md TD-47: Update templates (#1) 2022-02-02 12:15:10 +03:00
rebar.config TD-47: Update templates (#1) 2022-02-02 12:15:10 +03:00

{{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.