Team Overcast

Patrick Bartlett, Michelle Jakab, Gwennie Kidd, Terence Tong, Shreya Tumma

CloudHaven - Product Vision

CloudHaven provides a service for users to contain all of their important portals and applications, such as healthcare, banking, etc., in one place.

CloudHaven will be a service for applications to use to build their front-end UI, UI-as-a-service.

CloudHaven will keep user data safe and secure by holding all personal information in one place, rather than spread out across many applications.

This tool will also provide a messaging system that gives a platform for vendors to communicate effectively with their customers.

The future goal of CloudHaven is to give users the ability to customize the interface for different applications.

Tech Stack

Front-end: React.js

Back-end: Node.js, Express.js

State management: Redux, Context

Database: DynamoDB

Developer Onboarding

1. Install Node.js

   • https://nodejs.org/en/

2. Install Express

   • https://expressjs.com/en/starter/installing.html

3. Clone this repo onto your local machine.

4. Run 'npm install' in 'Overcast/' to update the packages and dependencies.

5. Run 'node server.js' in 'Overcast/' to run the backend server.

   • If the server is running, you will see this message in terminal: 'Server up and listening on 5000!'

6. Open another terminal and go to 'Overcast/cloud-haven-react-app/'.

7. Run 'npm install' in 'Overcast/cloud-haven-react-app/' to update the packages and dependencies.

8. Run 'npm i --save @fortawesome/fontawesome-svg-core' in 'Overcast/cloud-haven-react-app/'.

9. Run 'npm i --save @fortawesome/free-solid-svg-icons' in 'Overcast/cloud-haven-react-app/'.

10. Run 'npm i --save @fortawesome/react-fontawesome' in 'Overcast/cloud-haven-react-app/'.

11. Run 'npm start' in 'Overcast/cloud-haven-react-app/' to run the web application.

Setting Up The Local Database

1. Install the AWS CLI

2. Setup the local database

Setting up the tables in the database

Going through the above links should tell you how to set the database up locally. To test these changes you have to setup the table as well. I will explain how to do so below.

3. Make sure the database is running
   • navigate to the directory where DynamoDBLocal_lib exists
   • run the following command java -Djava.library.path=./DynamoDBLocal_lib -jar DynamoDBLocal.jar -sharedDb and leave this terminal open i.e DO NOT TERMINATE THIS PROCESS
4. run the file called dynamoDb.sh by using source dynamoDb.sh or ./dynamoDb.sh
5. to test if the tables were created run aws dynamodb list-tables --endpoint-url http://localhost:8000
   • you should see a table called Accounts

Continuous Integration

Status

Contributor Guide

You're all set up to start contributing to CloudHaven! Make sure to follow the code standard that is listed below. Happy coding :)

Folder Naming

• lower-case

File Naming

React

• UpperCamelCase

Node

• camelCase

Naming

• be descriptive
• no unambiguous abbreviations
• parameters and local variables are all lowerCamelCase
• package names are all lowerCamelCase
• class names are all UpperCamelCase
• method names are all lowerCamelCase
• @private methods must have trailing underscore (), lowerCamelCase

Formatting

• required for all loops/conditionals
• empty blocks should be on same line, function doNothing() {}
• 4 space indentation