arch/sliproad
1
0
Fork 0
mirror of https://github.com/gmemstr/sliproad.git synced 2024-09-19 16:11:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add frontend blurb.

Browse source
This commit is contained in:
Gabriel Simmer 2021-05-29 22:49:17 +01:00 committed by GitHub
parent 60b69213ae
commit c8a898d861
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -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
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
This project is largely API-first, and documentation can be found here: