Skip to content

Latest commit

 

History

History
18 lines (16 loc) · 1.27 KB

README.md

File metadata and controls

18 lines (16 loc) · 1.27 KB

Development Guide

  1. Setup SSH keys. ssh-keygen -t ed25519 -C "[email protected]"
  2. Add the public key to the list of SSH keys in your GitHub account. cat /home/ubuntu/.ssh/id_ed25519.pub
  3. Clone the repository. git clone [email protected]:usefulcoin/paper-kit-react-template.git
  4. Change the working directory and execute the setup script. cd paper-kit-react-template && bash setup.bash
  5. Install node modules. npm install
  6. Start. npm start
  7. If the build on port 3000 meets your approval, quit (Ctrl-C / ^C) and deploy. bash deploy.bash

Quick Start Gotchas

  1. Don't forget to create the S3 repository and update the name of the S3 repository used in deploy.bash.
  2. Don't forget to update the value of homepage in package.json.
  3. Don't forget to navigate over to GitHub and setup gh-pages to use docs/ to hold the build.
  4. Don't forget to pull those changes to your development environment before running bash deploy.bash.

Credits

  1. Creative Tim and the folks behind the Paper-Kit SCSS library.
  2. Zoom image bloggers W3Bitsand the Stack Overflow crew.