mirror of
https://github.com/valitydev/dmt-client.git
synced 2024-11-06 01:15:22 +00:00
899bd71161
* Drop proprietary CI stuff * Sync with valitydev/erlang-templates@da1971c * Update to valitydev/dmt-core@7584133
45 lines
1.1 KiB
Markdown
45 lines
1.1 KiB
Markdown
# dmt-client
|
|
|
|
The [dominant](https://github.com/valitydev/dominant) client with rich API and caching.
|
|
|
|
## Building
|
|
|
|
To build the project, run the following command:
|
|
|
|
```bash
|
|
$ make compile
|
|
```
|
|
|
|
## Running
|
|
|
|
To enter the [Erlang shell][1] with the project running, run the following command:
|
|
|
|
```bash
|
|
$ 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](https://docs.docker.com/buildx/working-with-buildx/) locally, or exporting the `DOCKER_BUILDKIT=1` environment variable.
|
|
|
|
#### Example
|
|
|
|
* This command will run the `compile` task in a docker container:
|
|
```bash
|
|
$ make wc-compile
|
|
```
|
|
#### Example
|
|
|
|
* This command will run the `compile` task in a docker container:
|
|
```bash
|
|
$ make wc-compile
|
|
```
|
|
|
|
## Documentation
|
|
|
|
@TODO Please write a couple of words about what your project does and how it does it.
|
|
|
|
[1]: http://erlang.org/doc/man/shell.html
|