Skip to content

Commit fbf4476

Browse files
karencarreonkarencarreon
authored
Merge pull request #1 from codepath/isabel-addfilestructure
Add all files and readme
2 parents fee9e54 + 6283a01 commit fbf4476

File tree

9 files changed

+268
-1
lines changed

9 files changed

+268
-1
lines changed

‎README.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,49 @@
1-
# web103_finalproject
1+
# [your app name here]
2+
3+
CodePath WEB103 Final Project
4+
5+
Designed and developed by: [your names here]
6+
7+
🔗 Link to deployed app:
8+
9+
## About
10+
11+
### Description and Purpose
12+
13+
[text goes here]
14+
15+
### Inspiration
16+
17+
[text goes here]
18+
19+
## Tech Stack
20+
21+
Frontend:
22+
23+
Backend:
24+
25+
## Features
26+
27+
### [Name of Feature 1]
28+
29+
[short description goes here]
30+
31+
[gif goes here]
32+
33+
### [Name of Feature 2]
34+
35+
[short description goes here]
36+
37+
[gif goes here]
38+
39+
### [Name of Feature 3]
40+
41+
[short description goes here]
42+
43+
[gif goes here]
44+
45+
### [ADDITIONAL FEATURES GO HERE - ADD ALL FEATURES HERE IN THE FORMAT ABOVE; you will check these off and add gifs as you complete them]
46+
47+
## Installation Instructions
48+
49+
[instructions go here]

‎milestones/milestone1.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Milestone 1
2+
3+
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.
4+
5+
## Checklist
6+
7+
This unit, be sure to complete all tasks listed below. To complete a task, place an `x` between the brackets.
8+
9+
- [ ] Read and understand all required features
10+
- [ ] Understand you **must** implement **all** baseline features and **two** custom features
11+
- [ ] In `readme.md`: update app name
12+
- [ ] In `readme.md`: add all group members' names
13+
- [ ] In `readme.md`: complete the **Description and Purpose** section
14+
- [ ] In `readme.md`: complete the **Inspiration** section
15+
- [ ] In `planning/user_stories.md`: add all user stories
16+
- [ ] In `planning/feature_list.md`: list all features you intend to include in your app
17+
- [ ] In this document, complete the **Reflection** section below
18+
19+
## Reflection
20+
21+
### 1. What went well during this unit?
22+
23+
[👉🏾👉🏾👉🏾 your answer here]
24+
25+
### 2. What were some challenges your group faced in this unit?
26+
27+
[👉🏾👉🏾👉🏾 your answer here]
28+
29+
### 3. What additional support will you need in upcoming units as you continue to work on your final project?
30+
31+
[👉🏾👉🏾👉🏾 your answer here]

‎milestones/milestone2.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Milestone 2
2+
3+
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.
4+
5+
## Checklist
6+
7+
This unit, be sure to complete all tasks listed below. To complete a task, place an `x` between the brackets.
8+
9+
- [ ] In `planning/wireframes.md`: add wireframes for at least three pages in your web app
10+
- [ ] In `planning/entity_relationship_diagram.md`: add the entity relationship diagram you developed for your database
11+
- [ ] Prepare your three-minute pitch presentation, to be presented during Unit 7 (the next unit)
12+
- [ ] You do **not** need to submit any materials in advance of your pitch
13+
- [ ] In this document, complete the **Reflection** section below
14+
15+
## Reflection
16+
17+
### 1. What went well during this unit?
18+
19+
[👉🏾👉🏾👉🏾 your answer here]
20+
21+
### 2. What were some challenges your group faced in this unit?
22+
23+
[👉🏾👉🏾👉🏾 your answer here]
24+
25+
### 3. What additional support will you need in upcoming units as you continue to work on your final project?
26+
27+
[👉🏾👉🏾👉🏾 your answer here]

‎milestones/milestone3.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Milestone 3
2+
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.
4+
5+
## Checklist
6+
7+
This unit, be sure to complete all tasks listed below. To complete a task, place an `x` between the brackets.
8+
9+
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.
10+
11+
- [ ] Create a project board associated with this repo
12+
- [ ] In this repo, create GitHub milestones for each of the remaining milestones in this unit
13+
- [ ] In this repo, create issues for each feature on your feature list
14+
- [ ] Make sure to add the issues to your project board and to the appropriate milestones
15+
- [ ] Update the status of issues in your project board as you complete them
16+
- [ ] In `readme.md`, check off the features you have completed in this unit by adding a ✅ emoji in front of their title
17+
- [ ] Under each feature you have completed, **include a GIF** showing feature functionality
18+
- [ ] In this document, complete the **Reflection** section below
19+
20+
## Reflection
21+
22+
### 1. What went well during this unit?
23+
24+
[👉🏾👉🏾👉🏾 your answer here]
25+
26+
### 2. What were some challenges your group faced in this unit?
27+
28+
[👉🏾👉🏾👉🏾 your answer here]
29+
30+
### 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?
31+
32+
[👉🏾👉🏾👉🏾 your answer here]
33+
34+
### Which features and user stories would you consider “at risk”? How will you change your plan if those items remain “at risk”?
35+
36+
[👉🏾👉🏾👉🏾 your answer here]
37+
38+
### 5. What additional support will you need in upcoming units as you continue to work on your final project?
39+
40+
[👉🏾👉🏾👉🏾 your answer here]

‎milestones/milestone4.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Milestone 4
2+
3+
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.
4+
5+
## Checklist
6+
7+
This unit, be sure to complete all tasks listed below. To complete a task, place an `x` between the brackets.
8+
9+
- [ ] Update the status of issues in your project board as you complete them
10+
- [ ] In `readme.md`, check off the features you have completed in this unit by adding a ✅ emoji in front of their title
11+
- [ ] Under each feature you have completed, **include a GIF** showing feature functionality
12+
- [ ] In this document, complete the **Reflection** section below
13+
14+
## Reflection
15+
16+
### 1. What went well during this unit?
17+
18+
[👉🏾👉🏾👉🏾 your answer here]
19+
20+
### 2. What were some challenges your group faced in this unit?
21+
22+
[👉🏾👉🏾👉🏾 your answer here]
23+
24+
### 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?
25+
26+
[👉🏾👉🏾👉🏾 your answer here]
27+
28+
### Which features and user stories would you consider “at risk”? How will you change your plan if those items remain “at risk”?
29+
30+
[👉🏾👉🏾👉🏾 your answer here]
31+
32+
### 5. What additional support will you need in upcoming units as you continue to work on your final project?
33+
34+
[👉🏾👉🏾👉🏾 your answer here]

‎milestones/milestone5.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Milestone 5
2+
3+
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.
4+
5+
## Checklist
6+
7+
This unit, be sure to complete all tasks listed below. To complete a task, place an `x` between the brackets.
8+
9+
- [ ] Deploy your project on Railway
10+
- [ ] In `readme.md`, add the link to your deployed project
11+
- [ ] Update the status of issues in your project board as you complete them
12+
- [ ] In `readme.md`, check off the features you have completed in this unit by adding a ✅ emoji in front of their title
13+
- [ ] Under each feature you have completed, **include a GIF** showing feature functionality
14+
- [ ] In this document, complete the **Reflection** section below
15+
16+
## Reflection
17+
18+
### 1. What went well during this unit?
19+
20+
[👉🏾👉🏾👉🏾 your answer here]
21+
22+
### 2. What were some challenges your group faced in this unit?
23+
24+
[👉🏾👉🏾👉🏾 your answer here]
25+
26+
### 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?
27+
28+
[👉🏾👉🏾👉🏾 your answer here]
29+
30+
### Which features and user stories would you consider “at risk”? How will you change your plan if those items remain “at risk”?
31+
32+
[👉🏾👉🏾👉🏾 your answer here]
33+
34+
### 5. What additional support will you need in upcoming units as you continue to work on your final project?
35+
36+
[👉🏾👉🏾👉🏾 your answer here]

‎planning/entity_relationship_diagram.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Entity Relationship Diagram
2+
3+
Reference the Creating an Entity Relationship Diagram final project guide in the course portal for more information about how to complete this deliverable.
4+
5+
## Create the List of Tables
6+
7+
[👉🏾👉🏾👉🏾 List each table in your diagram]
8+
9+
## Add the Entity Relationship Diagram
10+
11+
[👉🏾👉🏾👉🏾 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.]
12+
13+
| Column Name | Type | Description |
14+
|-------------|------|-------------|
15+
| id | integer | primary key |
16+
| name | text | name of the shoe model |
17+
| ... | ... | ... |

‎planning/user_stories.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# User Stories
2+
3+
Reference the Writing User Stories final project guide in the course portal for more information about how to complete each of the sections below.
4+
5+
## Outline User Roles
6+
7+
[👉🏾👉🏾👉🏾 Include at least at least 1, but no more than 3, user roles.]
8+
9+
## Draft User Stories
10+
11+
[👉🏾👉🏾👉🏾 Include at least at least 10 user stories in this format:]
12+
13+
1. As a [user role], I want to [what], so that [why].

‎planning/wireframes.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Wireframes
2+
3+
Reference the Creating an Entity Relationship Diagram final project guide in the course portal for more information about how to complete this deliverable.
4+
5+
## List of Pages
6+
7+
[👉🏾👉🏾👉🏾 List the pages you expect to have in your app, with a ⭐ next to pages you have wireframed]
8+
9+
## Wireframe 1: [page title]
10+
11+
[👉🏾👉🏾👉🏾 include wireframe 1]
12+
13+
## Wireframe 2: [page title]
14+
15+
[👉🏾👉🏾👉🏾 include wireframe 2]
16+
17+
## Wireframe 3: [page title]
18+
19+
[👉🏾👉🏾👉🏾 include wireframe 3]
20+
21+
[👉🏾👉🏾👉🏾 include more wireframes as desired]

0 commit comments

Comments
 (0)