Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the documentation #59

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update the documentation #59

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,14 @@ The important thing here is this is inspired by the original RubyFlow. Giving de

## Usage

Create the `secret` file for target environment:

```bash
$ cp config/dev.secret.example.exs config/dev.secret.ex
```

_If you are in `prod` environment you to copy the `prod.secret.example.exs` instead_

To start the ElixirStatus application:

1. Install mix dependencies with:
Expand All @@ -48,7 +56,7 @@ To start the ElixirStatus application:
$ npm install
```

3. Make sure you have MySQL installed and then configure the database accordingly in config/dev.exs and config/test.exs.
3. Make sure you have PostgreSQL installed and then configure the database accordingly in `config/dev.exs` and `config/test.exs`.

4. Create and migrate the database with:
```bash
Expand All @@ -60,7 +68,7 @@ To start the ElixirStatus application:
```bash
$ mix run priv/repo/seeds/seed.exs
```
6. [Register a GitHub application](https://github.com/settings/applications/new) for local testing:
6. [Register a GitHub application](https://github.com/settings/applications/new) to enable user authentication with GitHub:

Application name: `<your choice>`

Expand Down