Skip to content

Latest commit

 

History

History
9 lines (8 loc) · 736 Bytes

CONTRIBUTING.md

File metadata and controls

9 lines (8 loc) · 736 Bytes

If you can think of something nice to add or want to change / extend some of the functionality, feel free to create a Pull Request or an Issue. Please make sure to follow the code style (.prettierrc is included in the GitHub) and not break any of the existing functionality. Any help is greatly appreciated!

To setup a local environment you need to do the following steps:

  • Fork the repository to your GitHub account, so you can push your changes
  • Clone the repository
  • Install dependencies: npm install
  • Run the build npm run build (only required once to copy assets)
  • Start the Live Server: npm run start or npm run start:big
  • If you want to package OctoDash, so you can install it on your Raspberry Pi: npm run pack