Skip to content

Commit

Permalink
Update readme to partially account for final requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
jhagendoornCP authored Jun 4, 2024
1 parent d1e02a8 commit 7220ca9
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,28 @@
# Gather
## Gather ( NOT SURE WHICH ONE OF THESE DESCRIPTIONS WE PREFER )

Just a cool little inventory project.
Gather is for individuals who need a way to keep track of items when planning large events like a party or family gathering, moving to a new house, or going on a trip. Gather is a digital inventory management website that helps maintain, share, and organize multiple people’s items. Unlike traditional inventory management sites and check-off list tools that are designed for either an individual or a larger corporation, our product is made for both individuals and small groups of friends and family making it more friendly and easier to collaborate and communicate who has what items through integrated group functionalities.

## Overview
To allow students to keep track of their items after moving to college and organize the purchasing of items with their roommates!

Hi guys fixing my stuff.
## UI Prototype ( MIGHT NOT BE SHARED WITH ZIELKE??? )

### Purpose
https://www.figma.com/design/I5uSIz4KLxSyf4NDAFPLNC/Gather?node-id=40-177&t=qQE31y83u1B30ge8-0

## Dev environment setup
1. Clone the remote repository onto local machine
2. Run npm i or npm install
3. To run workspaces:
a) To run frontend: npm run front
b) To run backend: npm run back
c) To run test suite: npm run cyp

## UML Diagram
Create a wikipage (.md file) on your GitHub repository for the UML Class Diagram you have produced. Include the date the diagrams were last updated. Link to this page from your project README file. Also, push the source files of your diagram to the repo. I suggest you create a docs folder for the sake of organization.

To allow students to keep track of their items after moving to college and organize the purchasing of items with their roommates!

### Team

The Target Share team consists of 5 Cal Poly students. Over the course of about a month, we worked as a team to deploy this web application. The team members are listed below:
The gather team consists of 5 Cal Poly students. Over the course of about a month, we worked as a team to deploy this web application. The team members are listed below:

- [Jason Jelincic](https://www.linkedin.com/in/jasonjelincic/) - Software Developer
- [Zach Mattes](https://www.linkedin.com/in/zachmattes/) - Software Developer / Target guy!
Expand Down

0 comments on commit 7220ca9

Please sign in to comment.