BeakBox-Web

Overview

This repository contains code for the BeakBox website. It is a static HTML/CSS/JS website hosted on Netlify.

For the firmware, go to the Azure repository

Contributing

The project is configured to integrate with the VS Code's Prettier extension. Install and enable this to the workspace (it isn't recommended you enable this extension globally). From there, all formatting should be handled on file save.

Deployment Instructions

To run/test the website on a local web server first be sure to install the npm dependences - npm install and then use the npm start task.

• Making changes
  • Create a new branch and do your edits
  • Create a pull request to master on GitHub
  • Once reviewed, merge the PR into master
  • The site will automatically be deployed to Netlify

Links

• GitHub repo
• Website Documentation
  • Provides an overview of the templates and utility classes used in mybeakbox.com
• Azure DevOps Repo
  • Azure contains two repositories. One for the hardware's firmware and one to distribute that firmware on Firebase.
• Confluence
• Google Firebase Project
• Google Firebase CLI docs
• Site URL