76 lines
2.5 KiB
Markdown
76 lines
2.5 KiB
Markdown
|
# Phoenix Flake Template
|
||
|
|
|
||
|
|
This is a template for constructing a environment for Elixir development
|
||
|
|
(version 1.15.7, Erlang/OTP 25) with the [Phoenix](https://www.phoenixframework.org/)
|
||
|
|
(version 1.7.10) framework. [direnv](https://direnv.net/) can be used to launch
|
||
|
|
a dev shell upon entering this directory (refer to `.envrc`). Otherwise run via:
|
||
|
|
```bash
|
||
|
|
$ nix develop
|
||
|
|
```
|
||
|
|
|
||
|
|
## Quickstart
|
||
|
|
|
||
|
|
Run the Phoenix setup command and then start the local server:
|
||
|
|
```bash
|
||
|
|
$ mix deps.get
|
||
|
|
$ mix assets.setup
|
||
|
|
$ mix phx.server
|
||
|
|
```
|
||
|
|
|
||
|
|
## Dependencies
|
||
|
|
|
||
|
|
### Backend
|
||
|
|
|
||
|
|
Mix dependencies are packaged using [mix2nix](https://github.com/ydlr/mix2nix).
|
||
|
|
After updating your `mix.lock` file, make sure to re-run the following:
|
||
|
|
```bash
|
||
|
|
$ 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](https://nixos.org/manual/nixpkgs/stable/#packaging-beam-applications).
|
||
|
|
|
||
|
|
### Frontend
|
||
|
|
|
||
|
|
Frontend dependencies (i.e. assets found in the `/assets` folder) are packaged
|
||
|
|
using [node2nix](https://github.com/svanderburg/node2nix). You can generate the
|
||
|
|
relevant nix files for import using the following sequence of commands:
|
||
|
|
```bash
|
||
|
|
$ cd assets
|
||
|
|
$ rm -r node_modules # If this directory exists.
|
||
|
|
$ node2nix -l
|
||
|
|
```
|
||
|
|
In the above, we must remove `node_modules` (if it exists). Otherwise the
|
||
|
|
node packages will be included in the Nix build, influencing the outcome of
|
||
|
|
`node2nix`. The above generates three files:
|
||
|
|
|
||
|
|
* `node-packages.nix`
|
||
|
|
* Captures the packages that can be deployed (including all its required
|
||
|
|
dependencies)
|
||
|
|
* `node-env.nix`
|
||
|
|
* Contains build logic
|
||
|
|
* `default.nix`
|
||
|
|
* A composition expression allowing users to deploy the package. For an
|
||
|
|
example of this deployment, refer to `flake.nix`
|
||
|
|
|
||
|
|
NOTE: Do not update the lock version used in `assets`. `node2nix` currently only
|
||
|
|
supports lock versions 1 and 2.
|
||
|
|
|
||
|
|
## Language Server
|
||
|
|
|
||
|
|
The [elixir-ls](https://github.com/elixir-lsp/elixir-ls) LSP (version 0.17.10)
|
||
|
|
and [typescript-language-server](https://github.com/typescript-language-server/typescript-language-server)
|
||
|
|
(version 4.1.2) is included in this flake.
|
||
|
|
|
||
|
|
## Formatting
|
||
|
|
|
||
|
|
Formatting depends on [prettier](https://prettier.io/) (version 3.1.0) and the
|
||
|
|
`mix format` task. A `pre-commit` hook is included in `.githooks` that can be
|
||
|
|
used to format all `*.exs?`, `*.jsx?`, and `*.tsx?` files prior to commit.
|
||
|
|
Install via:
|
||
|
|
```bash
|
||
|
|
$ git config --local core.hooksPath .githooks/
|
||
|
|
```
|
||
|
|
If running [direnv](https://direnv.net/), this hook is installed automatically
|
||
|
|
when entering the directory.
|