Packages

raxx_kit

0.9.2
0.12.2 0.12.1 0.12.0 0.11.0 0.10.1 0.10.0 0.9.2 0.9.1 0.9.0 0.8.4 0.8.3 0.8.2 0.8.1 0.8.0 0.7.1 0.7.0 0.6.0 0.5.5 0.5.4 0.5.3 0.5.2 0.5.1 retired 0.5.0 0.4.4 0.4.3 0.4.2

Micro framework for web applications with Raxx and Ace.

HexDocs

Current section

Files

Jump to
Readme
26 Versions
0 Dependencies
0 Dependants
Files
Activity
raxx_kit priv template README.md.eex
Raw

priv/template/README.md.eex 

# <%= @module %>

<%= if @docker do %>

- Start your service with `docker-compose up`

- Run project test suite with `docker-compose run <%= @name %> mix test`

- Start IEx session in running service

      # Find a container id using docker ps

      docker exec -it <container-id> bash



      # In container

      iex --sname debug --remsh app@$(hostname)



Alternatively, you can still run the project directly, without docker:



<%= if @ecto do %>- Start just the database service with `docker-compose up db`

<% end %>- Install dependencies with `mix deps.get`<%= if @ecto do %>

- prepare the database using `mix do ecto.create, ecto.migrate`

<% end %>- Start your service with `iex -S mix`

<% else %>

- Install dependencies with `mix deps.get`<%= if @ecto do %>

- make sure your postgres db is running and configured correctly in `config/config.exs`

- prepare the database using `mix do ecto.create, ecto.migrate`

<% end %>- Start your service with `iex -S mix`

- Run project test suite with `mix test`

<% end %>

## Learn more



- Raxx documentation: https://hexdocs.pm/raxx

- Slack channel: https://elixir-lang.slack.com/messages/C56H3TBH8/