BNCHS Sentinels Website v5.0
The official website for the BNCHS Robotics Team | FRC Team #5599 - The Sentinels!
Hello World
The goal is to build a beautiful modern new website, while at the same time allowing students to learn the JavaSccript ecosystem with minimal experience.
Visit the live version over at beta.team5599.com.
Built with JavaScript, NextJS, and Redux
Getting Started
To work on this project, you will need to have git and NodeJS (v12 or higher) installed. If you don't have an editor yet, we recommend getting started with VSCode.
# Clone the project repository
git clone https://github.com/Team5599/BNCHS-Sentinels-Website-v5.git
# Navigate into the project directory
cd BNCHS-Sentinels-Website-v5
# Install dependencies
npm install
# Run the project locally
npm run dev
# This will start the nextJS application.
# A live version of the website will be available for you to preview at https://localhost:3000/
# This project supports "hot-reloading", meaning any changes you make and save in your editor
# will automatically update in the browser without needing to restart the program or reload the page
Visit http://localhost:3000/ in your browser to ensure the application is working.
If you have any issues with installation, please contact @MichaelRooplall
Resources
To learn more about React.js, take a look at the following resources:
- React.js Documentation - Learn about React.js features
- Intro to React.js - A introduction to React.js
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - Learn about Next.js features and API.
- Learn Next.js - An interactive Next.js tutorial.
To learn more about Redux, take a look at the following resources:
- Redux Fundamentals - Learn the core concepts, principles, and patterns of Redux
- Redux Tutorials - More resources for learning Redux
Deploying to Heroku
The heroku branch is responsible for deploying to our live production server Heroku.
You cannot push directly to the heroku branch. You must create a pull request to merge your branch into the heroku branch. When you create a pull request, an ESLint check is run against your changes.
The ESLint check is responsible for catching breaking bugs and unoptimizations before being deployed to Heroku.
Once the ESLint check is successful, the pull request can be merged. When merging is complete, GitHub Actions runs our "Heroku Deploy action", uploading the changes to our Heroku host.
API
Current documentation for the back-end API can be found here.
Contributors
\