70 lines (43 loc) · 1.57 KB

Contributing

Overview

This repo contains:

server/: An Elixir umbrella project containing a Phoenix REST server
client/: A React client using hooks

Getting Started

Server

To start the server, you will need the following tools installed:

Elixir 1.11.0, install here
Erlang 23.1, install here
PostgreSQL 10.2, install here

Once those are installed, we'll need to do a few setup tasks. Make sure to run any commands in the server/ directory.

Install the application dependencies:
```
mix deps.get
```
Create the database tables, migrate them, and add the seed data:
```
mix ecto.setup
```
Tip: If you need to reset the database can you run: mix ecto.reset. Also run mix help for a list of all the available commands.
Finally, we can start the server by running:
```
mix phx.server
```
And run the tests from the test/ directory by running:
```
mix test
```
Tip: Use mix test.watch to re-run the tests every time you save.

Client

To start developing the client, you will need the following tools installed:

Node 14.12.0, install here

Once you've installed these, run the following commands in the client/ directory.

Install the client dependencies:
```
npm install
```
Now start the client development server:
```
npm start
```
You can now view the client by visiting the localhost url the command outputs in your browser.