Skip to content

Latest commit

 

History

History
31 lines (25 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

31 lines (25 loc) · 1.02 KB
Raw

Peachy Tools Contributing

Hi! Thank you so much for your interest in contributing.

Adding a Tool

To create a new Tool as /my-new-tool

  1. Create and export your React Component at /js/tools/my-new-tool/ToolComponent.jsx.
  2. Add it to importTool() of ToolPage.
  3. Add it to Tool.js.
  4. Add it to swoff.js.

Deployment Checklist

  1. Push a commit that bumps up the version of Peachy Tools by modifying these files:
    • build-page.js
    • webpack.conf.js
    • swoff.js
  2. Use Google Cloud's Cloud Shell.
  3. Either git clone https://github.com/NimJay/peachy-tools.git or git pull on the existing repository clone.
  4. Go into the src/ folder.
  5. Reinstall npm modules:
    • rm -r node_modules
    • npm install
  6. Uncomment the Google Analytics <script> in js/server/build-page.js.
  7. npm run build-front-end-css
  8. npm run build-front-end-js
  9. If a new tool was added: npm run generate-code
  10. Upload the code to Google App Engine: gcloud app deploy