A Phoenix app for tracking clothes acquisition in Pokémon Sun & Moon.
Go to file
Lili (Tlapka) ee21d34e02 syntax fix 2021-10-20 14:33:15 +02:00
assets todo installation and attributions/pikachu added. 2021-10-19 17:39:50 +02:00
config syntax fix 2021-10-20 14:33:15 +02:00
lib add sentry 2021-10-20 14:21:25 +02:00
priv add username field, make it main log-in method 2021-10-11 15:04:46 +02:00
test fix settings controller tests (slight rewrite) 2021-10-13 12:40:55 +02:00
.formatter.exs initial commit 2021-06-28 11:14:14 +02:00
.gitignore initial commit 2021-06-28 11:14:14 +02:00
README.md add sentry to readme 2021-10-20 14:23:44 +02:00
mix.exs add sentry 2021-10-20 14:21:25 +02:00
mix.lock add sentry 2021-10-20 14:21:25 +02:00
sunmoon_clothes.csv take naming categories from game 2021-09-28 15:37:52 +02:00

README.md

Pokémon Couture

A work-in-progress Phoenix app for tracking clothes acquisition in Pokémon Sun & Moon.

Only supports female clothes for now, and has only been checked against a Pokémon Moon cartridge (and a bulbapedia clothes list.) Another check against Pokémon Sun would be useful.

I run a public version of the site at: https://couture.pikachu.rocks/

Currently, you need to have an account on the site to be able to use the tracker. Also, there is no e-mail server connected, so e-mails are not verified, and password resets and e-mail changes have to be done by contacting the admin.

TODO: Installation

Here is how to spin up your own Pokémon Couture Instance.

  1. Make sure you have Elixir, Phoenix, and a database like PostgreSQL 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 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.

Running in prod

To run the application in prod, you need to do some additional setup. Essentially the contents of the Phoenix deployment guide.

  1. export the SECRET_KEY_BASE and DATABASE_URL bash variables. You can get a secret with mix phx.gen.secret.
  2. Run npm install in the assets subfolder, then run npm run deploy --prefix ./assets in the project root folder.
  3. Run mix phx.digest in the project root folder.
  4. Run the server with PORT, HOST and MIX_ENV variables set, i.e. PORT=4001 MIX_ENV=prod HOST=couture.pikachu.rocks mix phx.server (or PORT=4001 MIX_ENV=prod HOST=couture.pikachu.rocks elixir --erl "-detached" -S mix phx.server). Optionally, also set a SENTRY_DSN variable with the link to your sentry dsn.

License and attributions

assets/static/images/pikachu.png is a pikachu icon by WEBTECHOPS LLP from the Noun Project, licensed as Creative Commons CCBY.

Possible future improvements

While the app is currently in a state that works, there are some improvements I would like to make for it later down the line.

Some of those are:

  • Support for male clothes
  • Support for the few extra items from Ultra Sun and Ultra Moon
  • A version of the tracker that works without an account
    • A transfer feature that allows to copy that progress upon account creation
  • Working e-mail verification
  • 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: