The communication platform for software teams.
You'll need to install the following dependencies first:
Run the bootstrap script to install the remaining dependencies and create your development database:
cd level
script/bootstrap
If your local PostgreSQL install does not have a default postgres user,
define the LEVEL_DB_USERNAME and LEVEL_DB_PASSWORD environment variables
first in your shell environment:
export LEVEL_DB_USERNAME=xxx
export LEVEL_DB_PASSWORD=yyy
Then run the bootstrap script again.
Use the script/server command to start up your local server and visit
localhost:4000 from your browser.
This repository includes a .nvmrc file targeting a specific version of Node
that is known the be compatibile with all current node dependencies. Things might work
with a newer version of Node, but the most guaranteed route is to install
Node Version Manager and run nvm install from
the project root.
Then, be sure to run script/bootstrap to install node dependencies with the
correct version of node.
Much of the front-end is powered by Elm.
The Elm code lives in the assets/elm/src directory and the corresponding test files
live in the assets/elm/tests directory.
To run the Elm test suite, execute script/elm-test from the project root.
When you install a new Elm package dependency, make sure you also add the same
dependency in the tests directory (the tests maintain their own set of dependencies):
# Install in the main elm package file
cd assets
./node_modules/.bin/elm-package install [package name]
# Install in the tests elm package file
cd tests
../node_modules/.bin/elm-package install [package name]Level uses subdomains to keep track of which space you are viewing. There are a variety
of different techniques for configuring a local TLD to point at localhost. One option is to
edit your /etc/hosts file with something like this to make the Phoenix app available
at http://launch.level.test:4000:
127.0.0.1 launch.level.test # required
127.0.0.1 yourspace.level.test # need an entry like this for every space you create
Caveat: The hosts file approach does not support wildcard subdomains, so you will have to add a new entry every time you create a new space. That's a pain.
Dnsmasq is a handy utility that can be used to forward all .test requests to localhost.
Follow these instructions to set it up on macOS.
To generate and view low-level API documentation locally, run the following script:
script/docs
©️ 2018 Derrick Reimer
Licensed under the Apache License, Version 2.0.