mirror of
https://github.com/CodingIsOurPassion/CodingIsOurPassion.git
synced 2024-12-30 16:29:18 -06:00
docs: add documentation stubs across entire tree
This commit is contained in:
parent
3b7e5c51f3
commit
7149948754
3
ARCHITECTURE.md
Normal file
3
ARCHITECTURE.md
Normal file
@ -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.
|
3
LakeWatch/README.md
Normal file
3
LakeWatch/README.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
# `LakeWatch`
|
||||||
|
|
||||||
|
This repository contains the actual Android application.
|
2
LakeWatchAPI/README.md
Normal file
2
LakeWatchAPI/README.md
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
# `LakeWatchAPI`
|
||||||
|
This repository contains the API used as the backend for our Android application.
|
3
LakeWatchScraper/README.md
Normal file
3
LakeWatchScraper/README.md
Normal file
@ -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.
|
21
README.md
Normal file
21
README.md
Normal file
@ -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.
|
Loading…
Reference in New Issue
Block a user