An event planning website for FFXIV.
Go to file
liv 1849f7ae34 fix: bump docker elixir version 2023-03-23 16:31:55 +01:00
assets fix: add dragoon to role selection 2022-08-29 10:31:42 +00:00
config fix: show parties with no members 2022-03-08 16:18:50 +01:00
lib chore: change IGN 2023-03-23 16:13:52 +01:00
priv feat: add separate admin team perm level 2022-09-03 09:42:06 +00:00
rel feat: add deploy files 2021-09-10 18:18:08 +02:00
test chore: mix format 2022-01-01 21:30:41 +01:00
.credo.exs feat: add and follow credo 2021-09-28 10:17:23 +02:00
.dockerignore fix: fix deployment 2021-09-21 17:14:28 +02:00
.editorconfig wip: add new table 2022-02-02 19:46:53 +01:00
.formatter.exs initial phoenix commit 2021-08-30 22:56:45 +02:00
.gitignore feat: support reassigning parties 2022-02-21 14:45:19 +01:00 doc: add basic 2022-03-16 09:27:50 +01:00 feat: add role explainer 2022-09-03 09:52:41 +00:00
Dockerfile fix: bump docker elixir version 2023-03-23 16:31:55 +01:00
LICENSE feat: adjust relative time formatter 2021-12-17 20:37:51 +01:00 docs: rewrite installation section 2021-10-16 14:14:38 +02:00
fly.stage.toml chore: fix staging env 2022-01-24 14:49:19 +01:00
fly.toml chore: adjust infra for staging deploy 2022-01-22 19:42:52 +01:00
mix.exs chore: bump version 2022-09-03 09:53:05 +00:00
mix.lock test: fix accounts tests 2021-12-22 16:40:24 +01:00
package-lock.json fix: show all roles for role selection 2022-08-24 14:25:43 +00:00
package.json fix: show all roles for role selection 2022-08-24 14:25:43 +00:00


Fernehalwes (Ferne for short) is a website that helps people host events in FFXIV.

Local Setup

Once you've cloned this repository, you want to make sure you've got Elixir installed. You also need a PostgreSQL version 11+ database server running somewhere. For the frontend, you need Node.js, as well. Preferably a recent version.

The first step is to install dependencies, using mix deps.get. This may prompt you to install something called Hex, that's okay. Then, install the local dependencies for the frontend using npm install or npm ci (that's faster).

Check the config/dev.exs file to set your local database credentials. By default, it uses socket auth, meaning that it relies on the default PostgreSQL config that local clients get passwordless access. If that's different for you, add a password key. Make sure to never check in these changes, since they're local to you.

Now you can set up your database! There's a shortcut task for this: mix ecto.setup. This creates and runs migrations on your database.

You should be ready for running Fernehalwes locally now. There's two main commands to do this:

  • mix phx.server: This is your standard "run the app" command.
  • iex -S mix phx.server: This does run the previous command, but it also gives you a neat interactive console (think rails console) so you can mess around with stuff. This is what I personally use, and I'd recommend it.

Fernehalwes is available locally on https://localhost:4000. Both commands automatically (re)compile assets. In development, no email provider is set up, so you can use the local mailbox at https://localhost:4000/dev/mailbox to catch emails sent to any address.