Update development instructions in readme

This commit is contained in:
Harshad Sharma 2024-05-23 14:27:46 +05:30
parent c0432883e5
commit 0b268f2cd1

View file

@ -1,9 +1,30 @@
# Freedive
To start your Phoenix server:
Dive into FreeBSD
Freedive aims to provide a mobile-first WebUI to manage FreeBSD hosts,
designed to welcome beginners, hobbyists and tinkerers
to the FreeBSD ecosystem with minimal fuss.
### Develop
Clone the repository:
- `git clone https://brew.bsd.cafe/hiway/freedive.git`
- `cd freedive`
Install dependencies:
- `pkg install -U -y inotify-tools doas`
Setup your own account to run commands as root without password:
- `echo "permit nopass <USERNAME> as root" >> /usr/local/etc/doas.conf`
Start Freedive:
* Run `mix setup` to install and setup dependencies
* Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`
* Start Freedive with `mix phx.server` or inside IEx with `iex -S mix phx.server`
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
@ -14,8 +35,6 @@ Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
do NOT create accounts for people you do not trust to have root access
on this machine.
### Devel
Create release:
- `mix release --overwrite`