mirror of
https://github.com/CodingIsOurPassion/CodingIsOurPassion.git
synced 2024-12-30 14:09:18 -06:00
feat(meetings): finalize proposal
This commit is contained in:
parent
32b1e78cd6
commit
0ee1e8010e
@ -3,31 +3,40 @@ date: 2024-06-10
|
|||||||
---
|
---
|
||||||
|
|
||||||
# Project Proposal
|
# Project Proposal
|
||||||
|
|
||||||
> **Objective**: The purpose of this assignment is to guide students in creating a comprehensive project proposal for an
|
> **Objective**: The purpose of this assignment is to guide students in creating a comprehensive project proposal for an
|
||||||
> Android application. This proposal will serve as the foundation for the semester-long project, outlining the project's
|
> Android application. This proposal will serve as the foundation for the semester-long project, outlining the project's
|
||||||
> goals, scope, features, and development plan.
|
> goals, scope, features, and development plan.
|
||||||
|
|
||||||
## Project Title and Overview
|
## Project Title and Overview
|
||||||
|
|
||||||
> - Choose a catchy and descriptive title for your Android application project.
|
> - Choose a catchy and descriptive title for your Android application project.
|
||||||
> - Provide a brief overview of the project, highlighting its purpose and potential impact.
|
> - Provide a brief overview of the project, highlighting its purpose and potential impact.
|
||||||
|
|
||||||
### Project Title
|
### Project Title
|
||||||
`LAKEWATCH: Canyon Lake`
|
|
||||||
|
**LAKEWATCH: Canyon Lake**
|
||||||
|
|
||||||
### Overview
|
### Overview
|
||||||
|
|
||||||
Our app will track a few things: water data of the lake, like water level, weather forecasts, like wind and temperature, and boat ramp statuses, like what boat ramps are open or closed.
|
Our app will track a few things: water data of the lake, like water level, weather forecasts, like wind and temperature,
|
||||||
|
and boat ramp statuses, like what boat ramps are open or closed.
|
||||||
|
|
||||||
This app will be useful for informing lake-goers of conditions at the lake, especially of the boat ramps. Furthermore, it'll bring awareness to Lake Canyon's falling water levels and hopefully cause concerns on whether Lake Canyon will even be around in another decade.
|
The app will be useful for informing lake-goers of conditions at the lake, especially of the boat ramps. Furthermore,
|
||||||
|
it'll bring awareness to Lake Canyon's falling water levels and hopefully cause concerns on whether Lake Canyon will
|
||||||
|
even be around in another decade.
|
||||||
|
|
||||||
## Project Goals and Objectives
|
## Project Goals and Objectives
|
||||||
|
|
||||||
> - Clearly define the goals and objectives of your Android application. What problem does it solve, and what benefits
|
> - Clearly define the goals and objectives of your Android application. What problem does it solve, and what benefits
|
||||||
> will users gain?
|
> will users gain?
|
||||||
|
|
||||||
- Problem: It's hard to know statuses on various services and conditions of Lake Canyon.
|
- Problem: It's hard to know statuses on various services and conditions of Lake Canyon as a bunch of different
|
||||||
|
organizations have differing levels of access and presentation of Lake Canyon data.
|
||||||
- Solution: Provide those statuses in a single centralized location that's easy to use.
|
- Solution: Provide those statuses in a single centralized location that's easy to use.
|
||||||
|
|
||||||
## Target Audience
|
## Target Audience
|
||||||
|
|
||||||
> - Identify and describe the target audience for your application. Consider demographics, interests, and needs that
|
> - Identify and describe the target audience for your application. Consider demographics, interests, and needs that
|
||||||
> your app addresses.
|
> your app addresses.
|
||||||
|
|
||||||
@ -36,28 +45,57 @@ This app will be useful for informing lake-goers of conditions at the lake, espe
|
|||||||
- Boaters and sailors on Lake Canyon (like those at Lake Canyon Yacht Club)
|
- Boaters and sailors on Lake Canyon (like those at Lake Canyon Yacht Club)
|
||||||
|
|
||||||
## Scope of the Project
|
## Scope of the Project
|
||||||
|
|
||||||
> - Outline the features and functionalities that your Android application will include. Clearly define what is within
|
> - Outline the features and functionalities that your Android application will include. Clearly define what is within
|
||||||
> the scope of this project and what might be considered for future enhancements. Your app must take input from the
|
> the scope of this project and what might be considered for future enhancements. Your app must take input from the
|
||||||
> user and also incorporate data - plan for file I/O.
|
> user and also incorporate data - plan for file I/O.
|
||||||
|
|
||||||
- Water Data
|
- Water Data
|
||||||
|
- Historical data
|
||||||
- Water level
|
- Water level
|
||||||
- Water temperature
|
- Water temperature
|
||||||
- Weather Data
|
- Weather Data
|
||||||
- Wind speed
|
- Wind speed
|
||||||
- Temperature
|
- Temperature
|
||||||
- Weather conditions (storms, lightning)
|
- Weather conditions (storms, lightning)
|
||||||
- Lake Services
|
- Boat ramp information
|
||||||
- Boat Ramp status
|
- Boat Ramp status, open or closed
|
||||||
- Map of services
|
- Addresses of the ramps
|
||||||
|
- Images of the ramps
|
||||||
|
|
||||||
|
This data will be incorporated by reading an API we're writing and a cache we maintain local to the app. Please see
|
||||||
|
[here](https://github.com/CodingIsOurPassion/CodingIsOurPassion/tree/main/LakeWatchAPI) for the API and
|
||||||
|
[here](https://github.com/CodingIsOurPassion/CodingIsOurPassion/tree/main/LakeWatchScraper) for how we're getting the
|
||||||
|
data.
|
||||||
|
|
||||||
## User Interface (UI) Design
|
## User Interface (UI) Design
|
||||||
|
|
||||||
> - Provide a high-level overview of the user interface design. Include sketches and descriptions of the app's key
|
> - Provide a high-level overview of the user interface design. Include sketches and descriptions of the app's key
|
||||||
> screens and interactions. The application should have a minimum of 4 views (screens).
|
> screens and interactions. The application should have a minimum of 4 views (screens).
|
||||||
|
|
||||||
- Talked about on 2024-06-18, updated MVPs will be finalized by 2024-06-19.
|
Our app's minimal viable product contains 4 to 5 views.
|
||||||
|
|
||||||
|
1. Our first view is the home view, acting as the primary portal to all other views within the app.
|
||||||
|
2. The second view is the weather view, containing data about weather conditions at Canyon Lake.
|
||||||
|
3. The third view is the water data view, containing information about water level, how full the lake is, historical
|
||||||
|
data, and more relating to Lake Canyon's water.
|
||||||
|
4. The fourth view is the boat ramp status view, containing information about if a ramp is open or closed, their
|
||||||
|
addresses, and more.
|
||||||
|
5. The last view is a settings menu, which currently contains only a dark mode toggle, but based on some discussions may
|
||||||
|
include a few additional features we're hammering out over the next week.
|
||||||
|
|
||||||
|
![Lake Watch Home Screen Sketch](./assets/project-proposal/images/Lakewatch-Homescreen.jpg)
|
||||||
|
|
||||||
|
![Lake Watch Weather View](./assets/project-proposal/images/Lakewatch-Weather.png)
|
||||||
|
|
||||||
|
![Lake Watch Water Data](./assets/project-proposal/images/Lakewatch-Waterdata.png)
|
||||||
|
|
||||||
|
![Lake Watch Boat Ramp Status](./assets/project-proposal/images/Lakewatch-Boat-Ramp.png)
|
||||||
|
|
||||||
|
![Lake Watch Settings](./assets/project-proposal/images/Lakewatch-Settings.jpg)
|
||||||
|
|
||||||
## Competition
|
## Competition
|
||||||
|
|
||||||
> - Identify your competition in the market. List 3 similar applications found in the apps store (include links).
|
> - Identify your competition in the market. List 3 similar applications found in the apps store (include links).
|
||||||
|
|
||||||
- [https://canyonlake.app](https://canyonlake.app)
|
- [https://canyonlake.app](https://canyonlake.app)
|
||||||
@ -67,11 +105,15 @@ This app will be useful for informing lake-goers of conditions at the lake, espe
|
|||||||
|
|
||||||
## Team Agreement
|
## Team Agreement
|
||||||
|
|
||||||
> - Download a copy of the team agreement document found [here](https://docs.google.com/document/d/1_k0sYuWC1sus3h5KOKiiPMZuqXfCBS3ywZpJo86izgg/edit?usp=sharing). Collaboratively review the agreement as a team, make any necessary modifications as specified, proceed to sign the team agreement, and attach it to the submission.
|
> - Download a copy of the team agreement document found
|
||||||
|
> [here](https://docs.google.com/document/d/1_k0sYuWC1sus3h5KOKiiPMZuqXfCBS3ywZpJo86izgg/edit?usp=sharing).
|
||||||
|
> Collaboratively review the agreement as a team, make any necessary modifications as specified, proceed to sign the
|
||||||
|
> team agreement, and attach it to the submission.
|
||||||
|
|
||||||
- See our agreement finished over [here](./assets/project-proposal/Team-Agreement-Document.typ)
|
- See the attached document
|
||||||
|
|
||||||
## Conclusion
|
## Conclusion
|
||||||
|
|
||||||
> - Summarize the key points of your project proposal
|
> - Summarize the key points of your project proposal
|
||||||
|
|
||||||
- Show data on Canyon Lake
|
- Show data on Canyon Lake
|
||||||
|
BIN
Meetings/assets/project-proposal/images/Lakewatch-Boat-Ramp.png
Normal file
BIN
Meetings/assets/project-proposal/images/Lakewatch-Boat-Ramp.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 3.1 MiB |
BIN
Meetings/assets/project-proposal/images/Lakewatch-Homescreen.jpg
Normal file
BIN
Meetings/assets/project-proposal/images/Lakewatch-Homescreen.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 385 KiB |
BIN
Meetings/assets/project-proposal/images/Lakewatch-Settings.jpg
Normal file
BIN
Meetings/assets/project-proposal/images/Lakewatch-Settings.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 293 KiB |
BIN
Meetings/assets/project-proposal/images/Lakewatch-Waterdata.png
Normal file
BIN
Meetings/assets/project-proposal/images/Lakewatch-Waterdata.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 81 KiB |
BIN
Meetings/assets/project-proposal/images/Lakewatch-Weather.png
Normal file
BIN
Meetings/assets/project-proposal/images/Lakewatch-Weather.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 475 KiB |
Loading…
Reference in New Issue
Block a user