Project Name

Know-how: A knowledge base app.

Team

• Product Owner: Amena Kauser Syeda
• Scrum Master: Sravanthi Karanam
• Development Team Members: Adelle Housker, Ted Green, Sravanthi Karanam, Amena Kauser Syeda

Table of Contents

1. Usage
2. Requirements
3. Development
   1. Installing Dependencies
   2. Tasks
4. Team
5. Contributing

Usage

Create a .env file in the root directory.

Create a DB instance on Amazon RDS (or create a local MySQL database).

Go to sendgrid.com, sign up for an account and generate an API key.

Add the following code in the .env file.

DBNAME=database-name DBUSERNAME=database-username DBPASSWORD=database-password DBHOST=amazonrds-db-hostname or localhost DBPORT=3306 SENDGRID_API_KEY=sendgrid-api-key S3accessKeyId =S3-access-keyId S3secretAccessKey=S3-secret-access-key S3Bucket=S3-bucket S3apiVersion=S3-version S3key=S3-key

Requirements

• ReactJS
• Node
• Express
• MySQL
• Sequelize

Development

Installing Dependencies

From within the root directory:

npm install

To start the server, run

npm run dev-start

In another terminal, run

npm run dev-react

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.