vincentoleary / NewForce-Group-Project-react-nutshell-puffinor

react-nutshell-puffinor created by GitHub Classroom

Reactive Nutshell: The Information Dashboard

Setup: Follow these steps exactly

1. Clone this repository
2. cd into the directory it creates
3. In the api directory, create a copy of the database.json.example and remove the .example extension.
4. Run npm install and wait for all dependencies to be installed
5. Run npm start to verify that installation was successful.

What is Reactive Nutshell?

Nutshell is a new product offering that you have been tasked with building. It's an app for people to use to organize their daily tasks, events, news article, friends, and chat messages.

You will be using the React library to build out this application.

To start you off, here's an example of what the resources in your API should look like once it's populated with some data from your application.

Users

{ "id": 1, "username": "Steve", "email": "[e-mail]" }

Messages

{ "id": 1, "userId": 1, "message": "What's up?" }

News

{
    "id": 1,
    "userId": 2,
    "url": "https://www.quantamagazine.org/newfound-wormhole-allows-information-to-escape-black-holes-20171023/",
    "title": "Wormholes Allow Information to Escape Black Holes",
    "synopsis": "Check out this recent discovery about workholes"
}

Friends

{ "id": 1, "userId": 1, "loggedInUserId": 3 }

Tasks

{ "id": 1, "userId": 3, "task": "Take out garbage" }

Professional Requirements

1. All teammates must use React and JSON-server.
2. Each module should have a comment at the top with the following info: author(s) and purpose of module
3. The README for your project should include instructions on how another person can download and run the application
4. An ERD showing the database relationships. A screenshot/image should be included on your README.

How to Handle Authentication

You will be using local storage to keep track of which user has logged into Nutshell. When the user fills out the registration form, you will POST their username and password to the users collection in your API. You will then immediately take the id of the object in the response and save it to local storage.

localStorage.setItem("activeUser", user.id)

If you add a Logout feature, all you will need to do is remove the session storage item.

localStorage.removeItem("activeUser")

Keep in mind some tips for a good usable app

1. Use acceptable conventions
   • Logo positioned at top left
   • Navigation across the top or down the left side
2. Visual hierarchy
   • Most important information is the most prominent
3. Break pages up into defined sections
   • Logically related content should be related visually
4. That which is clickable should be obviously clickable.
5. Eliminate distractions
   • Use only two typefaces
   • Limit color pallet (3 colors with black and white)
   • Use a grid
6. Support scanning (users don't read)
   • Use plenty of headings
   • Short paragraphs
   • Bulleted lists
7. Strive for consistency.