The BoardWise frontend/backend. https://www.boardwise.gg
 
 
 
 
 
 
Go to file
Joshua Potter a7a5e5298d Update package and package-lock. 2023-12-01 19:41:01 -07:00
.githooks Use typescript. 2023-12-01 18:48:47 -07:00
assets Update package and package-lock. 2023-12-01 19:41:01 -07:00
config Enable server on endpoint. 2023-12-01 19:40:50 -07:00
lib Setup React root node. 2023-12-01 12:56:14 -07:00
priv Clear default template, add boardwise metadata. 2023-12-01 11:40:26 -07:00
test Rename module to `boardwise`. 2023-11-30 10:25:00 -07:00
.envrc Add a formatting pre-commit hook. 2023-11-29 10:01:06 -07:00
.formatter.exs Initial commit. 2023-11-28 10:50:13 -07:00
.gitignore Use `db` for local database instance. 2023-12-01 11:00:43 -07:00
README.md Use `db` for local database instance. 2023-12-01 11:00:43 -07:00
default.nix Initial commit. 2023-11-28 10:50:13 -07:00
deps.nix Initial commit. 2023-11-28 10:50:13 -07:00
flake.lock Initial commit. 2023-11-28 10:50:13 -07:00
flake.nix Use typescript. 2023-12-01 18:48:47 -07:00
mix.exs Rename module to `boardwise`. 2023-11-30 10:25:00 -07:00
mix.lock Initial commit. 2023-11-28 10:50:13 -07:00

README.md

Phoenix Flake Template

This is a template for constructing a environment for Elixir development (version 1.15.7, Erlang/OTP 25) with the Phoenix (version 1.7.10) framework. direnv can be used to launch a dev shell upon entering this directory (refer to .envrc). Otherwise run via:

$ nix develop

Quickstart

An empty Postgres cluster is initialized at /db. To start the database, run the following:

$ pg_ctl -D db -l db/logfile -o --unix_socket_directories=@boardwise start

In the above command, @boardwise refers to an abstract socket name. Rename to whatever is appropriate for your use case. To then connect to this database instance, run:

$ psql -h @boardwise

To later shut the database down, run:

$ pg_ctl -D db stop

Afterward, you can run the Phoenix setup commands:

$ mix ecto.setup
$ mix assets.setup

and then start the local server:

$ mix phx.server

Dependencies

This project pins Mix dependencies using mix2nix. After updating your mix.lock file, make sure to re-run the following:

$ mix2nix > deps.nix

As of now, mix2nix cannot handle git dependencies found inside the mix.lock file. If you have git dependencies, add them manually or use FODs.

Language Server

The elixir-ls LSP (version 0.17.10) is included in this flake.

Formatting

Formatting depends on the mix format task. A pre-commit hook is included in .githooks that can be used to format all *.exs? files prior to commit. Install via:

$ git config --local core.hooksPath .githooks/

If running direnv, this hook is installed automatically when entering the directory.