This project's version of Ruby: ruby-3.1.3
.
- Jekyll
- Nodejs:
- Use NVM and
nvm use
to use this projects.nvmrc
file. Or use a bash function to automatically detect the.nvmrc
file.
- Use NVM and
git clone [email protected]:KankakeeCommunityCollege/athletics.git
cd athletics
npm i
bundle i
Never push a development build to GitHub!
npm run development
Productions builds also create a server at localhost:3000
to preview the production build.
If the build looks good, kill the processes in terminal (control + C,) add, commit, and push all changed files — including new JS bundles & chunks.
npm run production
This repository uses two main branches:
master
publish
Any edits pushed to the publish
branch will go live after a successful build in CloudCannon (which handles FTP.)
CloudCannon syncs with the master
branch where edits are staged. When ready, the edits can be published by merging the changes into the publish
branch.
CloudCannon has a mechanism to merge branches; this gives certain users the ability to make their (or others) changes live.
When developing locally, you need to use the same two branches to make your changes go live.
You may develop changes in your own branch, if you prefer. Simply merge your branch into the master
and publish
branches once ready. Also, be sure to delete merged branches if they were pushed to GitHub.
You may also develop locally in the master
branch. When ready, commit and push your edits to the master
branch. Then checkout the publish
branch, merge the edits (from master
) and push the changes to publish.