Skip to content

Latest commit

 

History

History
124 lines (97 loc) · 5 KB

README.md

File metadata and controls

124 lines (97 loc) · 5 KB
Raw

Reactive Nutshell: The Palm Beach Pilots

The Palm Beach Pilots are Chris Douglas, Colten Mayberry and Chad Clark from Cohort 47 of the Nashville Software School Full Stack Fulltime Web Development program.

Reactive Nutshell is an application that can be used to organize a person's daily tasks, upcoming events, news articles, and friends they can choose to chat with.

It is built on:

How To Deploy

In the root folder of project, run:

npm install
npm install json-server

In the api directory, create a copy of the database.json.example and remove the .example extension. Then run:

json-server -p 8088 -w database.json

To start the project:

npm start

The Weather APIs

Reactive Nutshell uses two different weather APIs:

Both of which require keys and both of which are free to use in the capacity they are being used in this application.

Once you have keys for both APIs you can copy WeatherSettings.js.example and remove the .example extension.

Inside WeatherSettings.js you can include your api keys into the quotes of weatherKey (OpenWeather) and weatherKey2 (Weatherbit.io).

WeatherSettings.js is included in the .gitignore so you do not have to worry about exposing your API keys.

Setup Instructions for Students

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 json-server -p 8088 -w database.json from the api directory.
  5. Run npm install and wait for all dependencies to be installed.
  6. Run npm start to verify that installation was successful.

Note: Your database.json file is already in the .gitignore file for this project, so it will never be added to the repo or pushed to Github.

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 some of the resources in your API should look like once it's populated with some data from your application.

Users

{ "id": 1, "name": "Steve Brownlee", "email": "[email protected]" }

Friends

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

News Articles

{
    "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",
    "timestamp": "2021-02-11T15:24"
}

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.

A Note About Authentication

We want you to know that the login and registration code we have given you is fake, completely insecure, and would never be implemented in a professional application. It is a simulation authentication using very simplistic tools, because authentication is not a learning objective of students at NSS.

You will be using session storage to keep track of which user has logged into Nutshell. You need to read the code in the Login.js and Register.js components so that you see what is going on, but you do not need to change it.

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.