NutShell

Welcome to Nutshell. It is a social platform that allows users to set tasks for themselves, create, update and delete news articles and events and also see that of your friends. Not only can you add more friends, but delete them when those ties fall sour. Users are also able to communicate with one another through the ChatRoom we created. Users are able to create, read, update and delete their most current message. We hope you enjoy our application!

Getting Started

These instructions will get you a copy of the project up and running on your local machine

Installing

First, you'll need to clone down the repo into a directory. Open your terminal and enter

git clone git@github.com:nss-c31-mixed-havoc/nutshell.git

After that, open up your editor. You're going to need to do the following:

• 1. go into the api/database.json.example file
• 2. Cmd + A (on Mac) or Ctrl + A (on Windows) to copy all of the example database
• 3. While in the api directory, make a new file and call it database.json
• 4. Cmd + V (on Mac) or Ctrl + V (on Windows) to paste database.json.example into database.json

Now, since you have an actual database.json, go back to your terminal, enter the command

cd src/lib

You will need to install node modules, run the command

npm install

Now, you are ready to run the application. In the terminal, run the following command

grunt

Your terminal should look similar to this, with no read errors:

The next thing to do is head over to your browser. Enter in the following url and press enter

http://localhost:8080

You are now ready to use NutShell.

First Time User instructions

• The first thing you have to do is register as new user otherwise you will not be able to use NutShell
• Once registered, you are now able to use the application
• Since there are only a few people in the database, you need more friends.

• Clicking on the Add Friend in the friends section, you can add these 5 users (the are current users: AlexT, JamekaE, JonS, BillyM, ChrisM)

• Another way is to go to the chat room and click on a user beside their message and add them.
• You now have friends.
• At this point, you can explore your dashboard, enter a new task, article, events. You are able to see your friends events and articles as well.
• While you're at it, if you want to go to the chat room with out any noise, go the navigation bar and click on the messages tab. You'll see just that, the chat room.

We hope you enjoyed our app! :)

Built With

• VanillaJS - The language we used
• browserify - Module Bundler
• grunt - JavaScript Task Runner
• Bootstrap4.3 - Used for styling

Authors

• Alex Thacker
• Jameka Echols
• Billy Mathison
• Chris Morgan
• Jonathon Schaffer

Acknowledgments

• Inspiration
• PurpleBooth - For their template