README stuff, hacky justfile added and demo is recorded

This commit is contained in:
Pagwin 2025-05-04 23:45:50 -04:00
parent 94fda78bd9
commit 9558d02f39
No known key found for this signature in database
GPG key ID: 81137023740CA260
7 changed files with 17 additions and 23 deletions

View file

@ -1,6 +1,6 @@
[![Review Assignment Due Date](https://classroom.github.com/assets/deadline-readme-button-22041afd0340ce965d47ae6ef1cefeee28c7c493a6346c4f15d667ab976d596c.svg)](https://classroom.github.com/a/vfKrPwQS) [![Review Assignment Due Date](https://classroom.github.com/assets/deadline-readme-button-22041afd0340ce965d47ae6ef1cefeee28c7c493a6346c4f15d667ab976d596c.svg)](https://classroom.github.com/a/vfKrPwQS)
# << Project Title >> # Binghamton Better Bus (BBB) v2
## CS 445 Final Project ## CS 445 Final Project
### Spring, 2025 ### Spring, 2025
@ -39,7 +39,7 @@ A list of features, function or non-functional, you would like to add in the fut
cd into the `src` directory and run `just setup` then run `docker-compose build`. cd into the `src` directory and run `just setup` then run `docker-compose build`.
To run just run `docker-compose up` in the `src` directory To run just run `docker-compose up` in the `src` directory, the site will be up on `localhost:8080`
## Built With ## Built With
@ -58,4 +58,3 @@ DIY license written out which grants MIT rights to professor moore for the versi
* Claude and chatGPT were used for the creation of scripts for certain rote data conversion tasks * Claude and chatGPT were used for the creation of scripts for certain rote data conversion tasks
* This project would not exist with the data it has if not for prior instances of attempts to make this idea by US, of particular note is the usage of GTFS data which was only learned of in a prior attempt with Lucy Loerker * This project would not exist with the data it has if not for prior instances of attempts to make this idea by US, of particular note is the usage of GTFS data which was only learned of in a prior attempt with Lucy Loerker
*

BIN
demo.mp4 Normal file

Binary file not shown.

13
src/Justfile Normal file
View file

@ -0,0 +1,13 @@
setup:
# this is a hack that is done due to a lack of communication
# towards the end of this project
# a slightly better hack could be done which avoids this but I
# don't wanna write things to work that way
cp -r client shared/client-dir
cp -r shared client/shared-dir
cp -r server/data shared/server-data
cp pubspec.yaml client/root-pubspec.yaml
cp pubspec.yaml shared/root-pubspec.yaml
clean:
rm -rf client/root-pubspec.yaml shared/root-pubspec.yaml shared/client-dir client/shared-dir shared/server-data

View file

@ -47,3 +47,4 @@ app.*.map.json
/android/app/release /android/app/release
shared-dir shared-dir
root-pubspec.yaml

View file

@ -1,10 +0,0 @@
name: cs445
environment:
sdk: ^3.7.0
workspace:
- shared
- client
dev_dependencies:
very_good_analysis: ^7.0.0

View file

@ -4,5 +4,6 @@
pubspec.lock pubspec.lock
client-dir client-dir
server-data server-data
root-pubspec.yaml
path.log path.log
notes.md notes.md

View file

@ -1,10 +0,0 @@
name: cs445
environment:
sdk: ^3.7.0
workspace:
- shared
- client
dev_dependencies:
very_good_analysis: ^7.0.0