- If you don't have NodeJS installed on your computer, install it here: https://nodejs.org/en/download/
- Clone the repository:
git clone git@github.com:Clemson-Esports/Clemson-Esports-Website.git. - Enter the directory:
cd Clemson-Esports-Website. - Install project dependencies:
npm i. - Install Nodemon (if you don't have it already):
npm install -g nodemon. - Run
nodemon.
You can now make changes to the website and see them by going to http://localhost:8080 in your browser.
Note: Because of Nodemon, you do NOT need to stop and restart nodemon every time you make a change, it will reflect automatically.
If you'd like to see the currently deployed development branch in the production environment, it is automatically deployed to the development Heroku instance here when a merge is made.
The production website will work the same way (of course, with the production URL when that time comes) where merges to main/master will automatically be deployed when a merge is finalized.
For the time being, we're currently using Github Projects to manage who's working on what.
To assign yourself to an issue/feature that no one has claimed:
- Go to the 'Projects' tab
- Go to 'Projects' (not the beta one if you see that)
- Select the current sprint
- Choose an issue and assign yourself to it.
Once you have finished your implementation:
- In the project sprint, move the card to 'Dev Complete',
- Submit a Pull Request into the 'Dev' branch originating from your branch.
- Assign two reviewers to review your PR.
- Once the reviewers have both approved the PR, you can merge your PR.
Once your change has been merged into the dev branch:
- Check the dev website (not set up yet) to make sure everything is functioning as normal.
- Wait for the dev branch to get merged into the production branch (master/main)