Skip to content

cavineers/CavineersWebsite

Repository files navigation

The Cavineers Website

This is the main repository for FRC team 4541's website code.

Documentation

This application is build on react and all of reacts' core dependencies using the "yarn" package manager.

Getting Started

In order to get started developing this application, a few steps must be closely followed.

  • Install NodeJS and the yarn package manager
  • Clone this repository from GitHub and cd into the root directory
  • Open a terminal in the root directory and run the command yarn install
  • The app is now ready to be launched run the command yarn start to start up the application

Pushing Build Releases to GitHub

When developing the application, React is being run in development mode meaning that it is optimized for code changes and not a production environment. Run the command yarn run build in the command line to build the application for production mode.

In order to push to GitHub pages, as stated in this resource, use the command yarn run deploy in order to build, publish, and deploy the code to GitHub pages.

Legal Terms

This application is protected under the APACHE-2.0 License terms. All Rights Are Reserved to the 4541 Cavineers. See our LICENSE for more information.