diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md new file mode 100644 index 0000000..4599218 --- /dev/null +++ b/ARCHITECTURE.md @@ -0,0 +1,3 @@ +# Architecture + +This document explains the architecture of our application, how and why our application is put together the way it is. diff --git a/LakeWatch/README.md b/LakeWatch/README.md new file mode 100644 index 0000000..717f9d0 --- /dev/null +++ b/LakeWatch/README.md @@ -0,0 +1,3 @@ +# `LakeWatch` + +This repository contains the actual Android application. diff --git a/LakeWatchAPI/README.md b/LakeWatchAPI/README.md new file mode 100644 index 0000000..c746935 --- /dev/null +++ b/LakeWatchAPI/README.md @@ -0,0 +1,2 @@ +# `LakeWatchAPI` +This repository contains the API used as the backend for our Android application. diff --git a/LakeWatchScraper/README.md b/LakeWatchScraper/README.md new file mode 100644 index 0000000..8476524 --- /dev/null +++ b/LakeWatchScraper/README.md @@ -0,0 +1,3 @@ +# `LakeWatchScraper` + +This repository contains the scraper used to pull data from other sources into a common data store for the API to serve. diff --git a/README.md b/README.md new file mode 100644 index 0000000..7a35eec --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# CodingIsOurPassion Group +This is the mono repository for our group at University of Texas at San Antonio in the Applications Programming course (CS-3443). + +Our group consists of the following members: +- [Ethan Grams](https://github.com/egramsdoescode) +- [Salman Abid](https://github.com/SlummyBoi) +- [Gavin Diab](https://github.com/HiIAmGrey) +- [Price Hiller](https://github.com/PriceHiller/) + +We chose to build an application named `LakeWatch` for our project. The intent is for it to present data about [Canyon +Lake](https://en.wikipedia.org/wikiCanyon_Lake_%28Texas%29) in an Android application applying principles learned in our +Application Programming course. + +## Organization of this Repository + +- `LakeWatchAPI` contains the backend service behind our Android application +- `LakeWatch` contains the main Android application for our project +- `LakeWatchScraper` contains the scraper service that goes out to various sites and actually pulls the data we need for the API. +- `Meetings` contains our meeting notes + +For more details please see the individual `README` of each project as applicable.