From d4e92b6938c37bf60a6b0975232b0cf8f73f6b6c Mon Sep 17 00:00:00 2001 From: Lili Date: Wed, 20 Oct 2021 16:02:05 +0200 Subject: [PATCH] readme wording changes, better line splits --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1f23d85..9cf29e0 100644 --- a/README.md +++ b/README.md @@ -10,15 +10,19 @@ and password resets and e-mail changes have to be done by contacting the admin. ## Installation Here is how to spin up your own Pokémon Couture Instance. -1. Make sure you have [Elixir](https://elixir-lang.org/install.html), [Phoenix](https://hexdocs.pm/phoenix/installation.html), and a database like [PostgreSQL](https://wiki.postgresql.org/wiki/Detailed_installation_guides) installed. You will also need `npm`. Also make sure that you have a C compiler and `make`. +1. Make sure you have [Elixir](https://elixir-lang.org/install.html), +[Phoenix](https://hexdocs.pm/phoenix/installation.html), +and a database like [PostgreSQL](https://wiki.postgresql.org/wiki/Detailed_installation_guides) installed. +You will also need `npm`. Also make sure that you have a C compiler and `make`. 2. Clone this git repository. 3. In the repository folder, run `mix deps.get` -At this point the setup is good enough for local testing. You can run `mix ecto setup`, then `iex -S mix phx.server` and go to `localhost:4000` to see the page in action. -For instructions on running the app in prod, read below. +At this point the setup is good enough for local testing. +You can run `mix ecto setup`, then `iex -S mix phx.server` to get the server running. +Go to `localhost:4000` to see the page in action. ### Running in prod To run the application in prod, you need to set a few environment variables, and run a few more commands. #### Environment variables -- `MIX_ENV=prod` to tell mix that you're running in prod. +- `MIX_ENV=prod` - `SECRET_KEY_BASE` for your secret. You can generate one with `mix phx.gen.secret`. - `DATABASE_URL` in the format of `ecto://USER:PASS@HOST/database` to connect to your database. - `PORT` for your app port. (usually 4000 or 4001) @@ -31,6 +35,9 @@ All of those commands are assuming you set the environment variables above. 3. Run `mix ecto.setup` to set up the database (and seed it). Now you can run the server. `mix phx.server` (or `elixir --erl "-detached" -S mix phx.server` for detached mode). + +You may also want to set up something like Caddy or nginx as a reverse proxy. + ## License and attributions `assets/static/images/pikachu.png` is a [pikachu icon by WEBTECHOPS LLP from the Noun Project](https://thenounproject.com/term/pokemon/2122740/), licensed as Creative Commons CCBY. @@ -47,6 +54,7 @@ Some of those are: - Better look for the tracker page - Display clothes in a more organized manner - Sort clothes the same way the game does it + ## Other clothing masterlists - inacuraccies My app has adapted the following masterlists, however, when checking in the actual Pokémon Moon game, I found several inacuraccies: