Onboarding_Guide

Onboarding

Tools Needed

• VS Code
• Node
• Github
• Clubhouse
• Basecamp

Tools Used

• Codacy
• ESLint
• Webpack
• Jest
• Puppeteer

Setting up your workspace

1. Make sure you have VS Code installed
   See VS Code extensions you should add
2. Clone the repository onto your local machine using git clone https://github.com/cse112-sp20/Quaranteam-8.git
3. Checkout the develop branch using git checkout origin/develop
4. If you don't have Node installed on your computer, install it from https://nodejs.org/en/download/. Once you have Node, go to the root of the repository and run npm install to install all dependencies
5. Build the project using npm run build

Loading the extension into Chrome

1. In chrome go to chrome://extensions
2. Toggle Developer Mode in the upper right corner
3. Select Load unpacked
4. Navigate to the project directory and select the dist folder
   You should now see the extension installed in your browser!

Signing in with a Clubhouse API key

1. Login to clubhouse.io with your account credentials
2. In the top right click on the dropdown menu then click settings
3. On the left, click on API Tokens
4. Enter any name for your token and click generate
5. This token will only be shown once, save it to some safe place!
6. Paste the token into the extension to complete login

Clubhouse

Clubhouse is where the stories you are assigned to will be placed. This helps the team keep track of the progress of the project.

Basecamp

Basecamp is where non-technical tasks you are assigned to will be placed in addition to project documents. There are Automatic Check-ins every week, but the only required one is the "What will you be working on this week?"

Next Steps

1. Review the repository structure
2. Take a code tour with our API Guide
3. Check out our documentation standards
4. Take a look at our quality control
5. Understand our testing procedures
6. Read the code design
7. Browse the tools guide