Official SwiFT Website

This repository hosts the source code of the website for a popular Rocket League team, SwiFT Freestyling.

The repository maintains a dev-master branch pattern to separate production-ready and development builds of the website. The master branch will host all source code being deployed to the web server, whereas the dev branch will host work-in-progress builds not yet deployed. When contributing to the repository, please create pull requests on the dev branch until they are fit to be merged onto the master at a later date.

This project is created using ReactJS (front-end) and Express (back-end).

Local Website

If you're interested in viewing the website locally, due to the framework used, it's not as easy as opening the index.html and expecting a copy of the website in your browser. Instead, you must use the build scripts provided by the ReactJS framework.

To run the website locally, follow the steps below:

Install Git and NodeJS/Node Package Manager (NPM)
Open the terminal (Git Bash for Windows users) in directory of your choosing (or on your Desktop) and clone the GitHub repository using git, git clone https://github.com/2008Choco/SwiFT-Website.git
A folder will be created in the directory where the command was run
- If any updates are made on git, you may pull these changes from GitHub using git pull
Change directories from the command line using cd Swift-Website (or whatever folder was downloaded from the git clone)
Be sure you're on the branch you wish to run locally, either master or dev.
- By default, you will be on master, but you may wish to switch with git checkout dev
Using NPM, run npm install to install all dependencies. This process may take a few minutes as there are a lot of dependencies.
Once all dependencies are installed, run npm start to start a local development server. Your browser will be opened to localhost on port 3000
- See "Available Scripts" -> npm start for more information on the start script

Contributing

If you would like to make a contribution, please do so on the dev branch. Changes will be merged into the master branch when they are deemed stable. It is encouraged that you test your changes using the above listed instructions before making a pull request and that your PR is as detailed as possible.

Available Scripts

In the project directory, you can run:

`npm start`

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

`npm test`

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

2008Choco/SwiFT-Website