Get started with Raxx + Elixir
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
guides
lib
priv/template
scripts
test
.formatter.exs
.gitignore
.travis.yml
CHANGELOG.md
ISSUE_TEMPLATE.md
LICENSE
README.md
mix.exs
mix.lock

README.md

Raxx.Kit

Tutorial for building a distributed chatroom with Raxx.Kit

Get started with Raxx + Elixir

$ mix archive.install hex raxx_kit
$ mix raxx.kit my_app

Includes:

  • Isolated web layer with Raxx
  • HTTP/2 support with Ace server
  • Middleware for request logging and static content.
  • Controller unit tests
  • Code reloading with ExSync

Options

  • --node-assets: Add JavaScript compilation as part of a generated project. Works with or without docker.

  • --docker: Create Dockerfile and docker-compose.yml in template. This allows local development to be conducted completly in docker.

  • --module: Used to name the top level module used in the generated project. Without this option the module name will be generated from path option.

    $ mix raxx.kit my_app
    
    # Is equivalent to
    $ mix raxx.kit my_app --module MyApp
  • --apib: Generate an API Blueprint file which is used as the project router.

Next

Contributing

NOTE: dotfiles in the priv directory are not automatically included in an archive.

Copyright and License

Raxx.Kit source code is released under Apache License 2.0.