HexWeb

Contributing

To contribute to HexWeb you need to properly setup your development environment.

Also see the client repository: hex.

PostgreSQL Modules

HexWeb requires the PostgreSQL Module pg_trgm to be available and enabled.

This is located in the "postgresql-contrib" package, however the package name can vary depending on your operating system. If the module is not installed the ecto migrations will fail.

Database

HexWeb connects to a localhost postgresql database hex_dev using the username postgresql with the password postgresql. Create this database/user if not already done:

CREATE USER postgres;
ALTER USER postgres PASSWORD 'postgres';
CREATE DATABASE hex_dev;
GRANT ALL PRIVILEGES ON DATABASE hex_dev TO postgres;

Now you are fine to run the ecto migrations:

mix ecto.migrate HexWeb.Repo

Sample Data

Using the following command you can seed your local HexWeb instance with some sample data:

mix run scripts/sample_data.exs

Running HexWeb

Once the database is setup you can start HexWeb:

# with console
iex -S mix run

# without console
mix run --no-halt

HexWeb will be available at http://localhost:4000/.