0.1.0 • Published 5 years ago

redapple-web v0.1.0

Weekly downloads
-
License
-
Repository
-
Last release
5 years ago

Running This Project

  • Install NodeJS - https://nodejs.org/en/
  • Clone this repo and cd into the project directory.
  • Run npm install
  • Run the project npm run start

NPM Scripts

  • start - Starts the metro bundler.
  • build - Ejects the build from Expo. (DO NOT USE without consulting everyone on this project first).
  • build:docs - Builds the statically generated documentation.
  • prettier - Cleans up code and makes all syntax consistent.
  • test - Runs code tests.

Documentation

Contribution

  • When commiting husky will run prettier, unit tests and build the static documentation.
  • Create or modify code in your own branch (Unless you otherwise have permission from the person who created the branch you want to edit) then create a pull request to update master.

Developer Notes

** Testing is not yet implementing due to these all being the start of the componenets. Tests should be written as soon as the componenets are styled / uppaded.

  • We are currently using Husky 3.1.0 which should be updated to Husky 4 once the bugs for commit hook not running is fixed.