Add overall project readme.md

This commit is contained in:
Aadi Desai 2022-06-13 11:43:05 +01:00
parent ad8955abf2
commit b08f35aa11
No known key found for this signature in database
GPG key ID: CFFFE425830EF4D9

17
readme.md Normal file
View file

@ -0,0 +1,17 @@
# ELEC60013 Embedded Systems: Coursework 1
## Project name: Barkr
## Repository Sections
- [App](./App/): The user app, built in Flutter
- [DataPuller](./DataPuller/): Data fetching script to pull data from cloud sources and forward to our backend, eg. AirTags DB or an MQTT broker
- [RPi](./RPi/): Program to run on the IOT device itself, collects pet information for the app and acts as a bluetooth beacon
- [Server](./Server/): Backend for interacting with the Firebase API and provides user signup abilities
- [Website](./Website/): Static marketting website built using Hugo, live at <https://barkr.8bitsqu.id/>
## Contributors
- [Aadi](https://github.com/supleed2/)
- [Benjamin](https://github.com/bo3z/)
- [Kacper](https://github.com/kmn219/)