boardwise
/
server
1
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Explain how to create/run a Mix release.

pull/3/head
Joshua Potter 2023-12-03 15:57:57 -07:00
parent a1dd46561d
commit e6d41a81a1
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -75,13 +75,26 @@ node packages will be included in the Nix build, influencing the outcome of
NOTE: Do not update the lock version used in `assets`. `node2nix` currently only
supports lock versions 1 and 2.
## Language Server
## Releases
To create a new [Mix release](https://hexdocs.pm/mix/1.12/Mix.Tasks.Release.html),
run `nix build` (after updating dependencies as outlined in the previous
section). You can test the release is functional by running:
```bash
$ export DATABASE_URL=ecto://<username>:<password>@<host>/<db_name>
$ export SECRET_KEY_BASE=$(mix phx.gen.secret)
$ result/bin/boardwise start
```
## Development
### 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
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