Skip to content

Commit

Permalink
fix QuickStart guide for our future
Browse files Browse the repository at this point in the history
  • Loading branch information
takasehideki committed Mar 15, 2024
1 parent c40b178 commit 405fad4
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
# ZenohexPhoenixDemo

To start your Phoenix server:
Note: we only confirmed the operation of this repository on the cloud VM in `MIX_ENV=prod`

* Run `mix setup` to install and setup dependencies
* Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`
To start your Phoenix server:

Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
* Adjust [config/config.exs#L15](https://github.com/b5g-ex/zenohex_phoenix_demo/blob/main/config/config.exs#L15) and [config/runtime.exs#L36](https://github.com/b5g-ex/zenohex_phoenix_demo/blob/main/config/runtime.exs#L36) to your server's URL
* Run `mix deps.get --only prod` to install and setup dependencies
* Run `MIX_ENV=prod mix compile` to compile project
* Run `MIX_ENV=prod mix assets.deploy` to assets
* Run `MIX_ENV=prod mix phx.gen.secret`, and set the result to `$SECRET_KEY_BASE`
* Then, start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`

Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html).
Now you can visit `<your_vm_url>:4000` from your browser.

## Learn more

Expand Down

0 comments on commit 405fad4

Please sign in to comment.