silentsilas
/
here-i-am
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme with prerequisites

This commit is contained in:
silentsilas 2024-07-17 18:35:16 -04:00
parent a085aee5c8
commit 583926a032
1 changed files with 56 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
README.md
View File

@ -1,5 +1,59 @@
# Here I Am
## Description
Here I Am is a Phoenix application that monitors devices connecting to your local network and plays a text-to-speech message using `espeak` when a new device is detected. The application uses `arp-scan` to identify devices on the network.
## Prerequisites
### Erlang and Elixir
In this project, these are managed by `asdf`. You will need to install ['https://github.com/asdf-vm/asdf](ASDF), ['https://github.com/asdf-vm/asdf-erlang](ASDF Erlang), and ['https://github.com/asdf-vm/asdf-elixir](ASDF Elixir). Be sure to read on what the Erlang / Elixir ASDF prerequisites are before installing the plugins.
Alternatively, you can install erlang/elixir without a version manager but that won't be covered here.
### Installing `espeak`
Install `espeak` on your system:
```bash
# On Debian/Ubuntu-based systems
sudo apt-get install espeak
# Fedora/RHEL
sudo dnf install espeak
```
### Installing `arp-scan`
Install `arp-scan` on your system:
```bash
# On Debian/Ubuntu-based systems
sudo apt-get install arp-scan
# Fedora/RHEL
sudo dnf install arp-scan
```
### Configuring `sudo` for `arp-scan`
To allow `arp-scan` to run without a password, edit the `sudoers` file:
```bash
sudo visudo
```
Add the following line to allow your user to run `arp-scan` without a password (replace `yourusername` with your actual username):
```plaintext
yourusername ALL=(ALL) NOPASSWD: /usr/sbin/arp-scan
```
Your arp-scan installation may not be in `/usr/sbin/arp-scan`. Please run `whereis arp-scan` to find the correct path for the above config.
## Setup
To start your Phoenix server:
* Run `mix setup` to install and setup dependencies
@ -7,12 +61,5 @@ To start your Phoenix server:
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html).
Ready to run in production? Please [check the deployment guides](https://hexdocs.pm/phoenix/deployment.html).
## Learn more
* Official website: https://www.phoenixframework.org/
* Guides: https://hexdocs.pm/phoenix/overview.html
* Docs: https://hexdocs.pm/phoenix
* Forum: https://elixirforum.com/c/phoenix-forum
* Source: https://github.com/phoenixframework/phoenix