Skip to content

Instantly share code, notes, and snippets.

@ada-instructors

ada-instructors/capstone_proposal_example.md

Created June 26, 2024 16:28
Show Gist options
  • Save ada-instructors/5fea3d96d6caaa6bbb61880f9f9abb67 to your computer and use it in GitHub Desktop.
Save ada-instructors/5fea3d96d6caaa6bbb61880f9f9abb67 to your computer and use it in GitHub Desktop.
Download ZIP
C21 Capstone Proposal Example
Raw
capstone_proposal_example.md

Parks for Humanity

Team members

  • Suzanne Avitus
  • Alderta Matéo

Problem Statement #1

  • Description:
    • There are approximately 343 parks in the City of Seattle! Some are just small slivers of land, and others are vast with miles and miles of trails. Kids or newbies to Seattle need a guide to help them explore all these beautiful parks. This application provides a map showing the location of all these parks and links you to the park details.
  • Input:
    • When visiting a park, users can check off that they've visited the park
    • Users can select a specific park
  • Outputs
    • A map of all the parks in Seattle
    • Park pages for a specified park selected by the user.
    • When a user has indicated that they've visited a certain number of parks, they receive a badge on their profile.
  • Ideal user(s)
    • Seattle newbies who like to enjoy the city's parks
    • Seattle natives who would like to find new parks to explore
    • Kids/parents of kids who need help finding their closest park

Learning Goals

  • Learn IOS Development
  • Learn to use a nosql database (Google Firebase)
  • Learn to use geographic data

Draft Technology Choices

  • IOS/Swift (Frontend)
  • Google Firebase (Backend)
  • Seattle Parks API (Backend)
  • Google Maps API (Backend)

MVP Feature Set

  1. A user can see a map with point locations of all seattle parks
    • The map point locations will indicate (by color or symbol) whether the user has visited the park yet
    • The user can zoom in and out of the map
    • The map also shows the user's current location
  2. The user can select a park point location, which navigates to a park details page.
    • If the user is signed in, the park details page shows whether or not the user has been there and a date of visit, if so
  3. A user can sign into the app to see their saved data
  4. A user can review a park once they have visited and are logged in.
    • The user can rate the park on a scale of 1-5 stars.
    • The user can write a review for the park.
    • The user can edit their review of the park.
  5. The user has an account details/achievements page
    • The page shows how many parks they have visited
    • The page shows the badges earned by visiting a certain number of parks.
    • The user can see a page of general info about the application (how to use, datasets involved, etc.)

Potential Additional Features

  1. Users can select a location and find parks within a specified range of that location.

Testing

  • Briefly describe how your team will approach testing.
    • Unit Tests - Each function, route and model will be tested independently. We will use the XCTest framework for the frontend and Jest for the backend.
    • Integration Testing - We'll be using Firebase Test Lab to do our integration testing as we bring our different features together.
    • UI Tests - We plan on using Firebase Test Lab for UI testing as well.

AI Implementation

  • We plan on using Github Copilot to help us write and debug code. If we have time, we would also like to use the OpenAI API to suggest Seattle parks that meet certain criteria via user input.

Division of Work

  1. Suzanne Avitus
    • Frontend implementation
    • Frontend Unit Testing
    • UI Testing
    • Integration Testing
  2. Alderta Matéo
    • Backend implementation
    • Backend Unit Testing
    • Integration Testing

Additional content, diagrams, wireframes, user flows, etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment