mirror of
https://github.com/gmemstr/sliproad.git
synced 2024-09-19 16:11:11 +01:00
Add frontend blurb.
This commit is contained in:
parent
60b69213ae
commit
c8a898d861
13
README.md
13
README.md
|
@ -52,6 +52,17 @@ After configuring the providers you would like to utilize, simply run
|
||||||
`./sliproad`. This will spin up the webserver at `127.0.0.1:3000`, listening on
|
`./sliproad`. This will spin up the webserver at `127.0.0.1:3000`, listening on
|
||||||
all addresses.
|
all addresses.
|
||||||
|
|
||||||
|
## Frontend
|
||||||
|
|
||||||
|
The frontend is a very lightweight JavaScript application and aims to be very
|
||||||
|
functional, if a bit rough around the edges.
|
||||||
|
|
||||||
|
![Screenshot_2021-05-29 Sliproad](https://user-images.githubusercontent.com/1878840/120085420-d63cbc80-c0cf-11eb-9fbb-b0b05a3f5d58.png)
|
||||||
|
|
||||||
|
It should scale reasonably well for smaller devices. Because it's now bundled
|
||||||
|
into the binary (as opposed to distributed alongside), it's no longer possible
|
||||||
|
to swap it out for a custom frontend without serving the frontend seperately.
|
||||||
|
|
||||||
## API
|
## API
|
||||||
|
|
||||||
This project is largely API-first, and documentation can be found here:
|
This project is largely API-first, and documentation can be found here:
|
||||||
|
@ -94,4 +105,4 @@ bugs utilizing it before this, _please_ open an issue so I can dig in further.
|
||||||
|
|
||||||
## Credits
|
## Credits
|
||||||
|
|
||||||
SVG Icons provided by Paweł Kuna: https://github.com/tabler/tabler-icons (see assets/web/icons/README.md)
|
SVG Icons provided by Paweł Kuna: https://github.com/tabler/tabler-icons (see assets/web/icons/README.md)
|
||||||
|
|
Loading…
Reference in a new issue