better readme

This commit is contained in:
Pagwin 2024-02-18 08:46:57 -05:00
parent 959e6938b0
commit 08bf39aab1

View file

@ -1,7 +1,10 @@
# BinghamtonBetterBus
Currently just an api to get the best bus route from point a to point b, currently building frontend
to run you need a file called GOOGLE_API_KEY in the dir the app is run in which has access to the routes api
There are 2 parts to this app, backend and frontend which are built with different commands. `cargo build` in the root directory will build the backend and `npm run build` in the BBB_frontend directory will build the frontend, run the backend and host the frontend with your preferred method of hosting static files and you're up and running.
In future I intend to improve the deoployment experience and madke it non-local by dockerizing things but when I tried during the hackathon I hit a cryptic nginx error.
to run you need a file called GOOGLE_API_KEY in the dir the app is run in which has access to the routes api (if you're nice you'll also replace the google api key in the frontend for google maps)
## TODO: