Skip to content

README.md

Latest commit

 

History

History
16 lines (9 loc) · 1.06 KB

README.md

File metadata and controls

16 lines (9 loc) · 1.06 KB

RoboGuide

A website with the collective knowledge of current and former members of the Team 41 Robotics programming team. View the site live at https://team41robotics.github.io/RoboGuide/.

Setup

First make sure to run npm install. This will install all the necessary dependencies.

There are two important scripts you can use during development.

  • npm start runs the app in development mode. Open http://localhost:3000 to view it.
  • npm run deploy builds the app and deploys it to GitHub Pages.

Contributing

My personal suggestion (as the Peter Linder) is to use the Atom IDE. If so, install the packages prettier-atom, linter, linter-ui-default, and linter-eslint. It'll make your code pretty. I believe the James Narayanan is more partial to VS Code, which also has a Prettier extension. Make sure to enable "Format on save" so it gets prettified automatically.