Blazerbots website

The public website is here https://ohsblazerbots.github.io/blazerbots/

🚀 Quick start

GitHub Codespaces

For the easiest setup, use GitHub Codespaces.

1. From the repo page on GitHub, go to Code -> Codespaces -> Create codespace.
2. Wait a bit for the Codespace to initialize. Once ready, you may skip to step 3 of the guide below.

Locally

1. Setup the repo.

   # Clone repo
   git clone https://github.com/OHSBlazerbots/blazerbots
   
   # Navigate to project directory
   cd blazerbots/
   
   # Install dependencies
   npm install

2. Start developing.

   Start up the project.

   npm start

3. Open the code and start customizing!

   Your site is now running at http://localhost:8000!

   Edit src/pages/index.tsx to see your site update in real-time!

   Note: For Codespaces, the site address will differ. Additionally, consider changing the Forwarded Port's visibility to Public, to make collaboration with teammates easier.

4. Learn more

   • Documentation
   • Tutorials
   • Guides
   • API Reference
   • Plugin Library
   • Cheat Sheet

Advanced: Using devcontainers locally

The devcontainer configuration used by Codespaces can also be used to setup a development environment on a local machine. For more information on this setup with VS Code, see here: https://code.visualstudio.com/docs/devcontainers/containers#_getting-started