lili
/
pokemon-couture
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

readme wording changes, better line splits

This commit is contained in:
Lili (Tlapka) 2021-10-20 16:02:05 +02:00
parent 498f419005
commit d4e92b6938
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -10,15 +10,19 @@ and password resets and e-mail changes have to be done by contacting the admin.
## Installation ## Installation
Here is how to spin up your own Pokémon Couture Instance. 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. 2. Clone this git repository.
3. In the repository folder, run `mix deps.get` 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. At this point the setup is good enough for local testing.
For instructions on running the app in prod, read below. 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 ### Running in prod
To run the application in prod, you need to set a few environment variables, and run a few more commands. To run the application in prod, you need to set a few environment variables, and run a few more commands.
#### Environment variables #### 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`. - `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. - `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) - `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). 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). 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 ## 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. `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 - Better look for the tracker page
- Display clothes in a more organized manner - Display clothes in a more organized manner
- Sort clothes the same way the game does it - Sort clothes the same way the game does it
## Other clothing masterlists - inacuraccies ## Other clothing masterlists - inacuraccies
My app has adapted the following masterlists, however, when checking in the My app has adapted the following masterlists, however, when checking in the
actual Pokémon Moon game, I found several inacuraccies: actual Pokémon Moon game, I found several inacuraccies: