From 2fb72951081495ed4cdbbe588553bf090e5e4b8b Mon Sep 17 00:00:00 2001 From: isabel-gwara Date: Wed, 5 Apr 2023 19:56:52 -0700 Subject: [PATCH 01/14] add file structure for planning --- planning/entity_relationship_diagram.md | 1 + planning/feature_list.md | 1 + planning/user_stories.md | 1 + planning/wireframe.md | 1 + 4 files changed, 4 insertions(+) create mode 100644 planning/entity_relationship_diagram.md create mode 100644 planning/feature_list.md create mode 100644 planning/user_stories.md create mode 100644 planning/wireframe.md diff --git a/planning/entity_relationship_diagram.md b/planning/entity_relationship_diagram.md new file mode 100644 index 000000000..2fd9f9570 --- /dev/null +++ b/planning/entity_relationship_diagram.md @@ -0,0 +1 @@ +TBD \ No newline at end of file diff --git a/planning/feature_list.md b/planning/feature_list.md new file mode 100644 index 000000000..2fd9f9570 --- /dev/null +++ b/planning/feature_list.md @@ -0,0 +1 @@ +TBD \ No newline at end of file diff --git a/planning/user_stories.md b/planning/user_stories.md new file mode 100644 index 000000000..2fd9f9570 --- /dev/null +++ b/planning/user_stories.md @@ -0,0 +1 @@ +TBD \ No newline at end of file diff --git a/planning/wireframe.md b/planning/wireframe.md new file mode 100644 index 000000000..2fd9f9570 --- /dev/null +++ b/planning/wireframe.md @@ -0,0 +1 @@ +TBD \ No newline at end of file From ec1d2ca9d779ef3ca70d3feff01b823444060104 Mon Sep 17 00:00:00 2001 From: isabel-gwara Date: Wed, 5 Apr 2023 20:18:28 -0700 Subject: [PATCH 02/14] Add readme --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index da06521fd..bb8e8f57d 100644 --- a/README.md +++ b/README.md @@ -1 +1,25 @@ -# web103_finalproject \ No newline at end of file +# [your app name here] + +Designed and developed by: [your names here] + +CodePath WEB103 Final Project + +## Description and Inspiration + +[text goes here] + +πŸ”— Link to deployed app: + +## Tech Stack + +Frontend: + +Backend: + +## Demo + +[gif goes here] + +## Installation Instructions + +[instructions go here] From 7023c24f68d7d7e5ce318df742fa3040ef03130f Mon Sep 17 00:00:00 2001 From: isabel-gwara Date: Wed, 5 Apr 2023 20:35:54 -0700 Subject: [PATCH 03/14] Add milestone 1 document --- milestones/milestone1.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 milestones/milestone1.md diff --git a/milestones/milestone1.md b/milestones/milestone1.md new file mode 100644 index 000000000..e17f12525 --- /dev/null +++ b/milestones/milestone1.md @@ -0,0 +1,31 @@ +# Milestone 1 Document + +This document should be completed and submitted during Unit 5 of this course. You **must** check off all completed tasks in this document in order to receive credit for your work. + +## Checklist + +This week, be sure to complete all tasks listed below. + +- [ ] Read and understand all required features + - [ ] Understand you **must** implement **all** baseline features and **two** custom features +- [ ] In `readme.md`: update app name +- [ ] In `readme.md`: add all group members' names +- [ ] In `readme.md`: complete the **Description and Purpose** section +- [ ] In `readme.md`: complete the **Inspiration** section +- [ ] In `planning/user_stories.md`: add all user stories +- [ ] In `planning/feature_list.md`: list all features you intend to include in your app +- [ ] In this document, complete the **Reflection** section below + +## Reflection + +### 1. What went well this week? + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] + +### 2. What were some challenges your group faced this week? + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] + +### 3. What additional support will you need in upcoming weeks as you continue to work on your final project? + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] From 231bae1e6d4c1b43537504abb1a2c56bb19de0e5 Mon Sep 17 00:00:00 2001 From: isabel-gwara Date: Wed, 5 Apr 2023 20:36:12 -0700 Subject: [PATCH 04/14] Update readme with description, purpose --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bb8e8f57d..cb55341b9 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,17 @@ Designed and developed by: [your names here] CodePath WEB103 Final Project -## Description and Inspiration +πŸ”— Link to deployed app: + +## About + +### Description and Purpose [text goes here] -πŸ”— Link to deployed app: +### Inspiration + +[text goes here] ## Tech Stack From b92e98b3c6f4f263790ea4137db4149e2b979c15 Mon Sep 17 00:00:00 2001 From: isabel-gwara Date: Wed, 5 Apr 2023 20:39:51 -0700 Subject: [PATCH 05/14] Styling and typos in milestone 1 --- milestones/milestone1.md | 4 ++-- planning/wireframe.md | 1 - 2 files changed, 2 insertions(+), 3 deletions(-) delete mode 100644 planning/wireframe.md diff --git a/milestones/milestone1.md b/milestones/milestone1.md index e17f12525..d235a4dde 100644 --- a/milestones/milestone1.md +++ b/milestones/milestone1.md @@ -1,10 +1,10 @@ # Milestone 1 Document -This document should be completed and submitted during Unit 5 of this course. You **must** check off all completed tasks in this document in order to receive credit for your work. +This document should be completed and submitted during **Unit 5** of this course. You **must** check off all completed tasks in this document in order to receive credit for your work. ## Checklist -This week, be sure to complete all tasks listed below. +This unit, be sure to complete all tasks listed below. - [ ] Read and understand all required features - [ ] Understand you **must** implement **all** baseline features and **two** custom features diff --git a/planning/wireframe.md b/planning/wireframe.md deleted file mode 100644 index 2fd9f9570..000000000 --- a/planning/wireframe.md +++ /dev/null @@ -1 +0,0 @@ -TBD \ No newline at end of file From 98fdac2a485be8e06673d5d7c5d7f8b790543e20 Mon Sep 17 00:00:00 2001 From: isabel-gwara Date: Wed, 5 Apr 2023 20:42:46 -0700 Subject: [PATCH 06/14] Add milestone 2 --- milestones/milestone1.md | 8 ++++---- milestones/milestone2.md | 27 +++++++++++++++++++++++++++ 2 files changed, 31 insertions(+), 4 deletions(-) create mode 100644 milestones/milestone2.md diff --git a/milestones/milestone1.md b/milestones/milestone1.md index d235a4dde..66b3dee2e 100644 --- a/milestones/milestone1.md +++ b/milestones/milestone1.md @@ -4,7 +4,7 @@ This document should be completed and submitted during **Unit 5** of this course ## Checklist -This unit, be sure to complete all tasks listed below. +This unit, be sure to complete all tasks listed below. To complete a task, place an `x` between the brackets. - [ ] Read and understand all required features - [ ] Understand you **must** implement **all** baseline features and **two** custom features @@ -18,14 +18,14 @@ This unit, be sure to complete all tasks listed below. ## Reflection -### 1. What went well this week? +### 1. What went well during this unit? [πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] -### 2. What were some challenges your group faced this week? +### 2. What were some challenges your group faced in this unit? [πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] -### 3. What additional support will you need in upcoming weeks as you continue to work on your final project? +### 3. What additional support will you need in upcoming units as you continue to work on your final project? [πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] diff --git a/milestones/milestone2.md b/milestones/milestone2.md new file mode 100644 index 000000000..dd869e885 --- /dev/null +++ b/milestones/milestone2.md @@ -0,0 +1,27 @@ +# Milestone 2 Document + +This document should be completed and submitted during **Unit 6** of this course. You **must** check off all completed tasks in this document in order to receive credit for your work. + +## Checklist + +This unit, be sure to complete all tasks listed below. To complete a task, place an `x` between the brackets. + +- [ ] In `planning/wireframes.md`: add wireframes for at least three pages in your web app +- [ ] In `planning/entity_relationship_diagram.md`: add the entity relationship diagram you developed for your database +- [ ] Prepare your three-minute pitch presentation, to be presented during Unit 7 (the next unit) + - [ ] You do **not** need to submit any materials in advance of your pitch +- [ ] In this document, complete the **Reflection** section below + +## Reflection + +### 1. What went well during this unit? + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] + +### 2. What were some challenges your group faced in this unit? + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] + +### 3. What additional support will you need in upcoming units as you continue to work on your final project? + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] From fa623056cf7cca320ac082af8536a42476bb7a77 Mon Sep 17 00:00:00 2001 From: isabel-gwara Date: Wed, 5 Apr 2023 20:43:45 -0700 Subject: [PATCH 07/14] Add stubs for additional milestones --- milestones/milestone3.md | 1 + milestones/milestone4.md | 1 + milestones/milestone5.md | 1 + 3 files changed, 3 insertions(+) create mode 100644 milestones/milestone3.md create mode 100644 milestones/milestone4.md create mode 100644 milestones/milestone5.md diff --git a/milestones/milestone3.md b/milestones/milestone3.md new file mode 100644 index 000000000..2fd9f9570 --- /dev/null +++ b/milestones/milestone3.md @@ -0,0 +1 @@ +TBD \ No newline at end of file diff --git a/milestones/milestone4.md b/milestones/milestone4.md new file mode 100644 index 000000000..2fd9f9570 --- /dev/null +++ b/milestones/milestone4.md @@ -0,0 +1 @@ +TBD \ No newline at end of file diff --git a/milestones/milestone5.md b/milestones/milestone5.md new file mode 100644 index 000000000..2fd9f9570 --- /dev/null +++ b/milestones/milestone5.md @@ -0,0 +1 @@ +TBD \ No newline at end of file From 0abb7a57ba1c01a7f81b52942aa31c214d47c29e Mon Sep 17 00:00:00 2001 From: isabel-gwara Date: Wed, 5 Apr 2023 21:24:44 -0700 Subject: [PATCH 08/14] Minor typo fixes --- milestones/milestone1.md | 2 +- milestones/milestone2.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/milestones/milestone1.md b/milestones/milestone1.md index 66b3dee2e..b9d32c03d 100644 --- a/milestones/milestone1.md +++ b/milestones/milestone1.md @@ -1,4 +1,4 @@ -# Milestone 1 Document +# Milestone 1 This document should be completed and submitted during **Unit 5** of this course. You **must** check off all completed tasks in this document in order to receive credit for your work. diff --git a/milestones/milestone2.md b/milestones/milestone2.md index dd869e885..7d7687f1e 100644 --- a/milestones/milestone2.md +++ b/milestones/milestone2.md @@ -1,4 +1,4 @@ -# Milestone 2 Document +# Milestone 2 This document should be completed and submitted during **Unit 6** of this course. You **must** check off all completed tasks in this document in order to receive credit for your work. From 0b26f97cc12bc7d193a8efd21945273e289a22ba Mon Sep 17 00:00:00 2001 From: isabel-gwara Date: Sun, 9 Apr 2023 12:57:17 -0700 Subject: [PATCH 09/14] Update readme with features --- README.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cb55341b9..0e1211217 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # [your app name here] -Designed and developed by: [your names here] - CodePath WEB103 Final Project +Designed and developed by: [your names here] + πŸ”— Link to deployed app: ## About @@ -22,10 +22,28 @@ Frontend: Backend: -## Demo +## Features + +### [Name of Feature 1] + +[short description goes here] [gif goes here] +### [Name of Feature 2] + +[short description goes here] + +[gif goes here] + +### [Name of Feature 3] + +[short description goes here] + +[gif goes here] + +### [ADDITIONAL FEATURES GO HERE - ADD ALL FEATURES HERE IN THE FORMAT ABOVE; you will check these off and add gifs as you complete them] + ## Installation Instructions [instructions go here] From 7ae18e6f6e6689e3eae4815f11e05732842c4b79 Mon Sep 17 00:00:00 2001 From: isabel-gwara Date: Sun, 9 Apr 2023 12:57:52 -0700 Subject: [PATCH 10/14] Remove feature_list.md --- planning/feature_list.md | 1 - 1 file changed, 1 deletion(-) delete mode 100644 planning/feature_list.md diff --git a/planning/feature_list.md b/planning/feature_list.md deleted file mode 100644 index 2fd9f9570..000000000 --- a/planning/feature_list.md +++ /dev/null @@ -1 +0,0 @@ -TBD \ No newline at end of file From 4bc4f254863a68ef5c93147adfbc8ba86e8d0063 Mon Sep 17 00:00:00 2001 From: isabel-gwara Date: Sun, 9 Apr 2023 18:20:07 -0700 Subject: [PATCH 11/14] Add milestone 3 --- milestones/milestone3.md | 41 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 40 insertions(+), 1 deletion(-) diff --git a/milestones/milestone3.md b/milestones/milestone3.md index 2fd9f9570..74f5aa99a 100644 --- a/milestones/milestone3.md +++ b/milestones/milestone3.md @@ -1 +1,40 @@ -TBD \ No newline at end of file +# Milestone 3 + +This document should be completed and submitted during **Unit 7** of this course. You **must** check off all completed tasks in this document in order to receive credit for your work. + +## Checklist + +This unit, be sure to complete all tasks listed below. To complete a task, place an `x` between the brackets. + +You will need to reference the GitHub Project Management guide in the course portal for more information about how to complete each of these steps. + +- [ ] Create a project board associated with this repo +- [ ] In this repo, create GitHub milestones for each of the remaining milestones in this unit +- [ ] In this repo, create issues for each feature on your feature list + - [ ] Make sure to add the issues to your project board and to the appropriate milestones +- [ ] Update the status of issues in your project board as you complete them +- [ ] In `readme.md`, check off the features you have completed in this unit by adding a βœ… emoji in front of their title + - [ ] Under each feature you have completed, **include a GIF** showing feature functionality +- [ ] In this document, complete the **Reflection** section below + +## Reflection + +### 1. What went well during this unit? + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] + +### 2. What were some challenges your group faced in this unit? + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] + +### Did you finish all of your tasks in your sprint plan for this week? If you did not finish all of the planned tasks, how would you prioritize the remaining tasks on your list? + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] + +### Which features and user stories would you consider β€œat risk”? How will you change your plan if those items remain β€œat risk”? + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] + +### 5. What additional support will you need in upcoming units as you continue to work on your final project? + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] From 02b81471bafb321b5e3b8870981770188c08d260 Mon Sep 17 00:00:00 2001 From: isabel-gwara Date: Sun, 9 Apr 2023 18:20:12 -0700 Subject: [PATCH 12/14] Add milestone 4 --- milestones/milestone4.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/milestones/milestone4.md b/milestones/milestone4.md index 2fd9f9570..8c781fd23 100644 --- a/milestones/milestone4.md +++ b/milestones/milestone4.md @@ -1 +1,34 @@ -TBD \ No newline at end of file +# Milestone 4 + +This document should be completed and submitted during **Unit 8** of this course. You **must** check off all completed tasks in this document in order to receive credit for your work. + +## Checklist + +This unit, be sure to complete all tasks listed below. To complete a task, place an `x` between the brackets. + +- [ ] Update the status of issues in your project board as you complete them +- [ ] In `readme.md`, check off the features you have completed in this unit by adding a βœ… emoji in front of their title + - [ ] Under each feature you have completed, **include a GIF** showing feature functionality +- [ ] In this document, complete the **Reflection** section below + +## Reflection + +### 1. What went well during this unit? + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] + +### 2. What were some challenges your group faced in this unit? + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] + +### Did you finish all of your tasks in your sprint plan for this week? If you did not finish all of the planned tasks, how would you prioritize the remaining tasks on your list? + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] + +### Which features and user stories would you consider β€œat risk”? How will you change your plan if those items remain β€œat risk”? + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] + +### 5. What additional support will you need in upcoming units as you continue to work on your final project? + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] From 0bfff01d1ce0f3832c423565010008a9432ded03 Mon Sep 17 00:00:00 2001 From: isabel-gwara Date: Sun, 9 Apr 2023 18:24:03 -0700 Subject: [PATCH 13/14] Add Milestone 5 --- milestones/milestone5.md | 37 ++++++++++++++++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/milestones/milestone5.md b/milestones/milestone5.md index 2fd9f9570..0c4949cd3 100644 --- a/milestones/milestone5.md +++ b/milestones/milestone5.md @@ -1 +1,36 @@ -TBD \ No newline at end of file +# Milestone 5 + +This document should be completed and submitted during **Unit 9** of this course. You **must** check off all completed tasks in this document in order to receive credit for your work. + +## Checklist + +This unit, be sure to complete all tasks listed below. To complete a task, place an `x` between the brackets. + +- [ ] Deploy your project on Railway + - [ ] In `readme.md`, add the link to your deployed project +- [ ] Update the status of issues in your project board as you complete them +- [ ] In `readme.md`, check off the features you have completed in this unit by adding a βœ… emoji in front of their title + - [ ] Under each feature you have completed, **include a GIF** showing feature functionality +- [ ] In this document, complete the **Reflection** section below + +## Reflection + +### 1. What went well during this unit? + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] + +### 2. What were some challenges your group faced in this unit? + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] + +### Did you finish all of your tasks in your sprint plan for this week? If you did not finish all of the planned tasks, how would you prioritize the remaining tasks on your list? + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] + +### Which features and user stories would you consider β€œat risk”? How will you change your plan if those items remain β€œat risk”? + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] + +### 5. What additional support will you need in upcoming units as you continue to work on your final project? + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] \ No newline at end of file From 6283a017dedce4c70f09807003249654e65adb75 Mon Sep 17 00:00:00 2001 From: isabel-gwara Date: Sun, 9 Apr 2023 18:35:02 -0700 Subject: [PATCH 14/14] Add stubs for three deliverables --- planning/entity_relationship_diagram.md | 18 +++++++++++++++++- planning/user_stories.md | 14 +++++++++++++- planning/wireframes.md | 21 +++++++++++++++++++++ 3 files changed, 51 insertions(+), 2 deletions(-) create mode 100644 planning/wireframes.md diff --git a/planning/entity_relationship_diagram.md b/planning/entity_relationship_diagram.md index 2fd9f9570..12c25f62c 100644 --- a/planning/entity_relationship_diagram.md +++ b/planning/entity_relationship_diagram.md @@ -1 +1,17 @@ -TBD \ No newline at end of file +# Entity Relationship Diagram + +Reference the Creating an Entity Relationship Diagram final project guide in the course portal for more information about how to complete this deliverable. + +## Create the List of Tables + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ List each table in your diagram] + +## Add the Entity Relationship Diagram + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ Include an image or images of the diagram below. You may also wish to use the following markdown syntax to outline each table, as per your preference.] + +| Column Name | Type | Description | +|-------------|------|-------------| +| id | integer | primary key | +| name | text | name of the shoe model | +| ... | ... | ... | diff --git a/planning/user_stories.md b/planning/user_stories.md index 2fd9f9570..1e55ecbcd 100644 --- a/planning/user_stories.md +++ b/planning/user_stories.md @@ -1 +1,13 @@ -TBD \ No newline at end of file +# User Stories + +Reference the Writing User Stories final project guide in the course portal for more information about how to complete each of the sections below. + +## Outline User Roles + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ Include at least at least 1, but no more than 3, user roles.] + +## Draft User Stories + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ Include at least at least 10 user stories in this format:] + +1. As a [user role], I want to [what], so that [why]. diff --git a/planning/wireframes.md b/planning/wireframes.md new file mode 100644 index 000000000..fbcd15a0c --- /dev/null +++ b/planning/wireframes.md @@ -0,0 +1,21 @@ +# Wireframes + +Reference the Creating an Entity Relationship Diagram final project guide in the course portal for more information about how to complete this deliverable. + +## List of Pages + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ List the pages you expect to have in your app, with a ⭐ next to pages you have wireframed] + +## Wireframe 1: [page title] + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ include wireframe 1] + +## Wireframe 2: [page title] + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ include wireframe 2] + +## Wireframe 3: [page title] + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ include wireframe 3] + +[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ include more wireframes as desired]