keanacobarde
commented
10 months ago FOUND README TEMPLATE
# This is the name of my Project [](https://app.netlify.com/sites/drt-sortinghat/deploys)
<!-- update the netlify badge above with your own badge that you can find at netlify under settings/general#status-badges -->
Here I am putting an overview of what my project is about. It comes below the name of my project so that others can read what it is about and get more details.
[View App](#your-link)
## Get Started <!-- OPTIONAL, but doesn't hurt -->
PLACE CODE SNIPPET HERE
## About the User <!-- This is a scaled down user persona -->
- The ideal user for this application is a teacher
- They have students in their classrooms that they would like to put into random groups and they have a love and passion of Harry Potter
- The problem this app solves for them is it allows them to get their students involved and excited about being in random groups. The students have felt that the groups have not been so random and based on favorites.
## Features <!-- List your app features using bullets! Do NOT use a paragraph. No one will read that! -->
- When a new student is added an object should be created and that object should be pushed into an array of students that then prints to the DOM.
- House Colors: The color of the student's card changes depending on which house they were sorted.
- Card Ordering: Sort the student cards by some criteria (i.e. alphabetically by name, by house)
- Voldermort's Army: Create a separate container of cards that hold the cards for students that have been expelled. These should be styled differently from Hogwarts students.
## Video Walkthrough of APP NAME <!-- A loom link is sufficient -->
https://www.loom.com/share/829b90d831ea441ba2db6bea724af210
## Relevant Links <!-- Link to all the things that are required outside of the ones that have their own section -->
- [Check out the deployed site](#your-link)
- [Wireframes](#your-link)
- [Project Board](#your-link)
## Code Snippet <!-- OPTIONAL, but doesn't hurt -->
PLACE CODE SNIPPET HERE
## Project Screenshots <!-- These can be inside of your project. Look at the repos from class and see how the images are included in the readme -->
<img width="1148" alt="Your Alt" src="your-link.png">
## Contributors
- [YOUR NAME](https://github.com/your-github-url)
User Story
I, as the curious employer, or the would-be contributor want to see the process of the creation of this application. This is best and most immediately seen within the readme. As a curious employer, I should get an immediate summary of what the project is about and have plenty of images that display the process and NOT just paragraphs of documentation. That's for second viewing!
Acceptance Criteria
SUGGESTED TEMPLATE. I know there's an example of a capstone read me somewhere. It'll be attached when I can find it:
Dependecies
N / A - This is an issue that can be tackled as the project goes along. All of your diagrams should be attached. Screenshots of the completed product should be attached. Your wireframe should be attached.
Dev Notes
SAMPLE FROM HHPW
npm start
const total = res.orderItems.reduce((acc, curr) => acc + curr.price, 0);