This project was bootstrapped with Create React App.

Working on the project

Things to install

1. (Optional): choco for Windows or homebrew for OSX
2. yarn
3. Sass
4. (Optional): VSCode
5. Recommended VSCode extensions (click the Extensions icon, which is the fifth one, and just type these in and install them). The only two that I think are necessary are the first two so that our code follows proper style and we all have the same style:
   • ESLint by Dirk Baeumer
   • TSLint by Sergii Naumov
   • Auto Import - ES6 & TS by Martin Oppitz
   • Auto Rename Tag by Jun Han
   • vscode-icons by Roberto Huertas
   • React Native Tools by Visual Studio Mobile Tools
   • Debugger for Chrome by Microsoft

Useful Links

1. React Guide
2. react-md (VERY useful for styling, try to use these components if possible).
3. react-md grid system (use this to understand react-md's grid layout, try to think about your components in grids)

Launching the project

# install necessary packagees of project
yarn or yarn install

# add new package
yarn add [package]

# remove a package
yarn remove [package]

# launch project
# this will also watch sass files
# if the page shows up blank, just refresh
yarn start

Adding a new component

First run the command below, then add an associated SCSS file in the Sass folder (you don't have to add the SCSS file if you don't edit any styles).

react-create component [component-name]

Version management

# pull the current version of the repo
git pull

# start a new branch
git checkout -b [name-of-branch]

# change working branch
git checkout [name-of-branch]

# add all files in working directory to commit
git add .

# add specific files
git add [file]

# commit changes
git commit -m "Message about changes!"

# switch back to master then merge changes
git checkout master
git merge [branch-to-merge]

# push to github
git push

Learn More About React

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.