new instructions.

Author: wlongmireBloomTech

README.md

@@ -1,84 +1,66 @@
-# Module Project: Component Lifecycle Methods - React Github User Card
+# Component Lifecycle Methods - React Github User Card
 
 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.
 
-## Introduction
 
-**Read these instructions carefully. Understand exactly what is expected _before_ starting this project.**
+## Objectives
+- Build class components from scratch from a Storyboard
+- Get comfortable creating multiple slices of state
+- Use ComponentDidMount to make an API call
+- Use ComponentDidUpdate to make an API call
+
+## Introduction
+In this project you will build an application that allows for github user and follower information to be retrieved and displayed within custom made DOM. You application should do the following:
+- Hold both the current user, user and follower state within the App.js component.
+- Load the current user state into the user state on mount.
+- Load the current user's followers into state when the current user state is updated.
+- Load the the user and follower information of the username typed into a form when submitted.
 
-### Commits
+<!-- ![Project Example](project-goals.gif) -->
 
-Commit your code regularly and meaningfully. This helps you and any collaborators in case you ever need to return to old code for any number of reasons.
+***Make sure to complete your tasks one at a time and complete test each task before proceding forward.***
 
 ## Instructions
-
 ### Task 1: Project Set Up
-
-- [ ] Create a forked copy of this project.
-- [ ] 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>`.
-
-Follow these steps for completing your project.
-
-- [ ] Submit a Pull-Request to merge <firstName-lastName> Branch into main (student's Repository). **Please don't merge your own pull request**
-- [ ] From the home page of your repo, make sure you have your branch selected
-- [ ] Copy the URL and paste it into Canvas
-
-### Task 2: Minimum Viable Product
-
-- [ ] 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
-
-#### Planning your App
-
-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.
-
-Also, since you have used the Github API before, you know some of the gotchas. Make sure to plan and watch for those.
-
-When you have those completed, you're ready to start coding!
-
-#### Fetch the User Data
-
-- 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 github name >
-- After you fetch your data, set it to state
-
-#### Display the User Data
-
-- 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
-
-#### Fetch the User's Followers
-
-- 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
-
-#### Style the User Card
-
-- 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.
-
-#### Project Retrospective
-
-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.
-
-### Task 3: Stretch Problems
-
-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:
-
-- 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.
-
-- 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
-
-## Submission Format
-
-- [ ] Submit a Pull-Request to merge <firstName-lastName> Branch into `main` (student's Repository). **Please don't merge your own pull request**
-- [ ] From the home page of your repo, make sure you have your branch selected
-- [ ] Copy the URL and paste it into Canvas to submit your project
+* [ ] Create a forked copy of this project.
+* [ ] Clone your OWN version of the repository in your terminal
+* [ ] cd into the project base directory `cd web-module-project-lifecycle`
+* [ ] Download project dependencies by running `npm install`
+* [ ] Start up the app using `npm start`
+
+### Task 2: Project Requirements
+#### Build your DOM
+> *Creating the DOM for your application base on your template and data*
+* [ ] Take a look at the [included mockup](./card_mockup.png).
+* [ ] Take a look at the data returned when using endpoint: https://api.github.com/users/< Your github name > and https://api.github.com/users/< Your github name >/followers
+* [ ] Using these three pieces of information, build the DOM necessary to display all application information.
+* [ ] Make use of the User.js (for holding all user information), FollowerList.js (for map through a followers list) and Follower.js (for displaying an individual follower) components to efficiently distribute your code. ***All components should be class based for this assignment.***
+* [ ] Feel free to leave the search form within App.js.
+* [ ] Lightly style as needed.
+* [ ] Commit all changes before proceeding.
+
+#### Add in your state
+> *Now that we have all the DOM necessary to run our application, let's proceed to building in our state*
+* [ ] In App.js, add in state. Include a slice for state for:
+    - A string defining the user we are currently searching for
+    - An object containing all user information
+    - The array of all followers
+* [ ] Using our two github endpoints as a base, add your github user name, as well as test data for the user object and followers array to insure it is connected correctly.
+
+#### Load in the user and follower on mount
+> *We can now do our api call to get our initial data*
+* [ ] Make our user object and follower list state empty by default.
+* [ ] Keep our searched user state your github username by default.
+* [ ] Use componentDidMount to load initial user data for your github name into state.
+* [ ] Use componentDidUpdate to load follower information ***only when the user slice of state changes value. Make be careful to avoid infinite loops while building this portion.***
+
+#### Build search capabilities within your APP
+> *Now let's allow users to search for new github usernames*
+* [ ] Connect your form in App.js so that typing into a input updated your current user state.
+* [ ] When your form is submitted, make an api call on current user. Set the returned user data to state.
+* [ ] Ensure that followers is correctly updated.
+
+### Task 3: Stretch goals
+- [ ] We are making several api calls of the same type in our code. How can we make this portion more dry?
+- [ ] Add in functionality so that when a follower is clicked, they will become the searched user. Have the UI update approprately.
+- [ ] Push your styling! Have fun!