Skip to content

Latest commit

 

History

History
94 lines (76 loc) · 4.62 KB

00-set-up.md

File metadata and controls

94 lines (76 loc) · 4.62 KB
Raw

Set up

Follow the instructions below to install, build, and run the Project Hoverboard locally in less than 15 minutes.

Install the Hoverboard and dependencies

  1. Fork repository and clone your fork locally
  2. Install Node.js (v16)
  3. Install project dependencies: npm ci (yarn should work but it's not officially supported)
  4. Create Firebase account and login into Firebase CLI: npx firebase login
  5. Update Hoverboard config and Resources. More info can be found here
  6. Import initial data to the Firebase Database
    • Generate serviceAccount.json file
      • Go to console.firebase.google.com -> Project settings -> Service accounts
      • Ensure that Node.js is selected and press Generate new private key
      • Read the warning and press Generate key
      • Save the file as serviceAccount.json and to the root of your hoverboard directory (❗Do NOT commit this file to the public repository)
    • Enable Firestore in web console at console.firebase.google.com -> Database -> Cloud Firestore -> Create database. Select locked mode and press Enable
    • [Optional] You can edit docs/default-firebase-data.json) file using your own data
    • Select your Firebase project npx firebase use <projectId>
      • [Optional] If you need to clear out all of your data first, run npx firebase firestore:delete --recursive --all-collections
      • Run npm run firestore:init

Directory structure

The diagram below is a brief summary of the directories within the project.

/
|---config/
|---data/
|---dist/
|---docs/
|---functions/
|---images/
|---scripts/
|---node_modules/
|---src/
|   |---components/
|   |---elements/
|   |---mixins/
|   |---pages/
|
  • config/ folder for core project setup.
  • data/ folder with all data for the template including rest of config and resources for pages.
  • dist/ is the directory to deploy to production.
  • docs/ documentation.
  • functions/ directory with Firebase cloud functions used for notifications, optimizations, saving data, etc.
  • images/ is for static images.
  • scripts/ contains scripts that helps user to work with the project and it's data (docs).
  • node_modules/ is the place of Node dependencies.
  • src/ is where you store all of your source code and do all of your development.
    • components/ is where you keep your new LitElement custom elements.
    • elements/ is where you keep your old Polymer custom elements.
    • mixins/ is where you keep your shared component mixins.
    • pages/ is where you keep your pages' description.

Build and serve

  1. Specify the Firebase project to use for development and deploy target
    • npx firebase use <projectid>.
  2. Run locally
    • npm start
  3. Deploy
    • npm run deploy

There are two CLI flags you can set when running npm scripts:

  • NODE_ENV: Control if code should be optimized for a production deployment with minimization or for faster local development.
  • BUILD_ENV: Which config JSON file should be used when building. This is where you set the Firebase project details.

The common npm scripts are:

  • npm start: Start a local development server using the Firebase emulator with livereload.
  • npm run build: Build a production version of the site to the dist directory.
  • npm run serve: Build a production version of the site and serve it locally.
  • npm run deploy: Build a production version of the site and deploy it to Firebase.

Below is the grid of the common npm script commands and their supported CLI flags.

NODE_ENV BUILD_ENV
start development development|production|custom
build production development|production|custom
serve production development|production|custom
deploy production development|production|custom

For example npm start only supports NODE_ENV=development and defaults to BUILD_ENV=development while npm run build only supports NODE_ENV=production and defaults to BUILD_ENV=production.

Next steps

Now that your Hoverboard is up and running, learn how to configure the app for your needs, or how to deploy the app to the web.