Add project instructions

Author: dustinmyers

.gitignore

@@ -1,68 +1,80 @@
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+# Module Project: Comppnent Lifecycle Method - React Github User Card
 
-## Available Scripts
+This project allows you to practice the concepts and techniques learned in this module and apply them in a concrete project. This module explored lifecycle methods in class components. In your project you will demonstrate proficiency of these concepts by recreating the Github User Card project, but as a React application this time.
 
-In the project directory, you can run:
+## Instructions
 
-### `npm start`
+**Read these instructions carefully. Understand exactly what is expected _before_ starting this project.**
 
-Runs the app in the development mode.<br>
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+### Commits
 
-The page will reload if you make edits.<br>
-You will also see any lint errors in the console.
+Commit your code regularly and meaningfully. This helps both you and your team lead in case you ever need to return to old code for any number of reasons.
 
-### `npm test`
+### Description
 
-Launches the test runner in the interactive watch mode.<br>
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+In this project you'll take this crypto currency tracker app and build two custom hooks that, when composed together, will allow users to set and persist a dark mode preference.
 
-### `npm run build`
+## Project Set Up
 
-Builds the app for production to the `build` folder.<br>
-It correctly bundles React in production mode and optimizes the build for the best performance.
+- [ ] Create a forked copy of this project.
+- [ ] Add your team lead as collaborator on Github.
+- [ ] Clone your OWN version of the repository in your terminal
+- [ ] Use CRA to create a new React app in this repository
+- [ ] Create a new branch: git checkout -b `<firstName-lastName>`.
+- [ ] Implement the project on your newly created `<firstName-lastName>` branch, committing changes regularly.
+- [ ] Push commits: git push origin `<firstName-lastName>`.
 
-The build is minified and the filenames include the hashes.<br>
-Your app is ready to be deployed!
+Follow these steps for completing your project.
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+- [ ] Submit a Pull-Request to merge <firstName-lastName> Branch into master (student's Repository). **Please don't merge your own pull request**
+- [ ] Add your team lead as a reviewer on the pull-request
+- [ ] Your team lead will count the project as complete by merging the branch back into master.
+- [ ] Do your magic!
 
-### `npm run eject`
+## Minimum Viable Product
 
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+- [ ] Fetch data from the Github API for a Github user
+- [ ] Display the user data on the DOM
+- [ ] Use class components when you need to hold any state or use any lifecycle methods
 
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+## Planning your App
 
-Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+This is an important step for any project you will be working on. You will want to plan out what data you will need, which component will manage that data via state, what functions you may need to update that state, and where you need to pass the data to render it to the DOM. I love to use pen and paper or a whiteboard for this. The visuals can help a lot when you're deep into your code. After I finish that, I will write out a list of steps that I think it will take to build the app. This gives me a starting point, and direction as I proceed. This list always changes a bit as you are building, but it should give you a good flow and some good anchor points.
 
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+When you have those completed, you're ready to start coding!
 
-## Learn More
+## STEP 1 - Fetch the User Data
 
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+- When your component mounts, send a GET request to the following URL (replacing the palceholder with your Github name):
+  - https://api.github.com/users/<your name>
+- After you fetch your data, set it to state
 
-To learn React, check out the [React documentation](https://reactjs.org/).
+## STEP 2 - Display the user data
 
-### Code Splitting
+- Pass the data to the component that will be displaying it
+- Build out a user card using the data that the Github API returns to you
+  - You may reference your old project for this, or you may wish to build this from scratch yourself
 
-This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
+## STEP 3 - Fetch the User's Followers
 
-### Analyzing the Bundle Size
+- When your component mounts, you will also fetch the user's followers using this endpoint:
+  https://api.github.com/users/<Your github name>/followers
+- Set that data to state as well, and display the data in your app
 
-This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
+## STEP 4 - Style the User Card
 
-### Making a Progressive Web App
+- Now it's time to style up your app
+- You are free to choose how you style your app, but make it look as presentable as you can
+- Try something new here. Maybe that's a new CSS technique you haven't really practiced yet. Maybe it's using a styling library you haven't tried. Push yourself to get better in this area.
 
-This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
+## STEP 5 - Project Retrospective
 
-### Advanced Configuration
+Now that you have completed the MVP, I want you to think about the process it took you to get here. Is there anything you wish you had planned better? Anything you would do differently? Now take a minute think about how you would accomplish these same objectives with function components and hooks. You have experience with both formats now, so you can form opinions, but more importantly, you can back up those opinions. That's a really exciting level to be at! If you have time now, go ahead and move onto the stretch problems.
 
-This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
+## Stretch Problems
 
-### Deployment
+After finishing your required elements, you can push your work further. These goals may or may not be things you have learned in this module but they build on the material you just studied. Time allowing, stretch your limits and see if you can deliver on the following optional goals:
 
-This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
+- Build a form that allows you to search for different Github users. When the form is submitted, use `componentDidUpdate` to fetch the data for the user you typed in. Set that new user's data to state to trigger the component to rerender and display your new user. Don't forget to fetch their followers as well.
 
-### `npm run build` fails to minify
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
+- Look into adding your GitHub contribution graph. There are a number of different ways of doing this, this Stack Overflow discussion will get you started: https://stackoverflow.com/questions/34516592/embed-github-contributions-graph-in-website