Skip to content

Latest commit

 

History

History
62 lines (50 loc) · 2.56 KB

README.md

File metadata and controls

62 lines (50 loc) · 2.56 KB
Raw

Nutshell: The Information Dashboard

Instructions on how to download and run Nutshell

  1. Navigate into a directory on your local machine where you want the project to be located
  2. Clone this Github Repository using either ssh or https into your directory
  3. Open a terminal window and navigate to the folder containing "package.json"
  4. Type the command npm install to install all dependencies
  5. While still in the same directory, start a http-server in the terminal; if needed download http-server via npm by typing npm install -g http-server more info: https://www.npmjs.com/package/http-server
  6. Open another terminal window or tab and if needed, navigate to the same directory and type in grunt
  7. Open up a window in your prefered web browser
  8. In the navigation bar type "127.0.0.1:" followed by the port number of your http-server

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

You will be utilizing all of the skills and concepts that you've learned up to this point in the course.

  1. Functions
  2. Databases
  3. Github
  4. Objects
  5. CSS
  6. Generators
  7. Handling user events
  8. Factory functions
  9. Data entry/editing
  10. Modular code with Browserify
  11. Relational data

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

const NutshellDatabase = {
    "users": [
        { "id": 1, "username": "Steve", "email": "me@me.com" },
        { "id": 2, "username": "Mark", "email": "you@you.com" },
        { "id": 3, "username": "Krista", "email": "foo@foo.com" }
    ],
    "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/", "note": "Check out this recent discovery about workholes" }
    ],
    "friends": [
        { "connectionId": 1, "userId": 1, "friendId": 3 },
        { "connectionId": 2, "userId": 1, "friendId": 2 }
    ],
    "tasks": [
        { "id": 1, "userId": 3, "task": "Take out garbage" }
    ]
}

Professional Requirements

  1. All teammates must be using Grunt to run ESLint and Browserify during development
  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