Skip to content

Commit

Permalink
Add demo setup instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
thebugcatcher committed Oct 29, 2023
1 parent 8935327 commit 03d1054
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,24 @@ main features:

## Installation

### Quick Setup for Demo/Testing (tested on Linux)

Pull the app and run with default config values:

__NOTE: Make sure other already running containers don't interfere with system
ports `5432` and `4000`__

* `make demo`
* This will start up docker containers needed to run the app
* Includes `postgres` and `phoenix` containers

* `make setup`
* This will run the DB migrations needed and setup your app

* Refer to [Configurations](#configurations) sections for default values.

### Proper setup

Keep the following things in mind:

* Ability to run Elixir or built erlang release
Expand Down
2 changes: 1 addition & 1 deletion config/dev.exs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ config :heimdall, Heimdall.Repo,
pool_size: 10

config :heimdall, HeimdallWeb.Endpoint,
http: [ip: {127, 0, 0, 1}, port: 4000],
http: [port: 4000],
check_origin: false,
code_reloader: true,
debug_errors: true,
Expand Down

0 comments on commit 03d1054

Please sign in to comment.