jquinsmith / sugar-deadies

Nutshell2

Nutshell:

Creators (AKA Sugar-Deadies)

1. Gradi Ellis,
2. Mark McCann,
3. Quin Smith,
4. Sage Klein

What is Nutshell...

Nutshell is a dashboard for anyone (especially "Day of the Dead" esthetic enthusiasts) to store and organize data for their every day lives. After Registering for an account, the user may login, and view all of their daily tasks, events, news articles, friends, and chat messages.

::Tasks

Upon login a user will be able to see their existing tasks which will appear in descending order. Users may add a task, or edit an existing task. Users may also check tasks off as completed, or just delete them.

::Events

Upon login a user will be able to see their existing events which will appear in ascending order. Users may add an event, or edit an existing event. Users may also delete an event.

::News

Upon login a user will be able to see their existing news articles which will appear in descending order with a time stamp attached. Users may add a news article, or edit an existing news article. Users may also delete news articles.

::Friends

Upon login a user will be able to see their friends. Users may add a friend from the chat message area. Users and friends of users will share visibility of each others information Users may view and delete existing friends.

::Chat Messages

Upon login a user will be able to see their chat message area. All messages of both the user and the users friends are visible in the chat area. All messages will display in ascending order. Users may delete their own personal chat messages only.

::Sessions Storage

Using session storage Sugar-Deadies were able to mimic multiple users using the site concurrently.

Dependencies Sugar-Deadies used to create Nutshell:

1. Functions
2. Databases/API
3. Github
4. CSS
5. Flexbox
6. React
7. Reactstrap/Bootstrap
8. Modals
9. Data entry/editing
10. Relational data
11. Session Storage

How to Launch Nutshell

1. Clone the repository from Github
2. Open your terminal and type the command "npm install" to install React
3. In the main project directory, create a new directory called "API"
4. In the API directory, create a file called "database.json"
5. Copy the sample data below into database.json
6. Run json-server in port 5002 with database.json
7. In the terminal, type the command "npm start". You are now ready to use Nutshell!

Naming Conventions Agreed Upon by Sugar-Deadies

1. Classes will contain dashes
2. ID's are camelCase
3. Uppercase .js files
4. .js files will match export default name