RDS, Carleton University’s design system, is a living digital organism uniting campus wide teams around a common visual language.
Note: the instructions below are for developing RDS and its documentation. For building projects with RDS, the latest documentation can be found at https://ravendesignsystem.github.io/rds/.
-
Clone project:
git clone https://github.com/ravendesignsystem/rds.git foldername
-
Install Sculpin and required npm packages with Composer:
php composer.phar install
-
Add an example .env file:
cp ./.env-example ./.env
-
Contact a RDS core contributor to get the info for the
.env
file.
-
Create a feature branch from the
develop
branch:git checkout -b feature_name develop
-
Build the static files, set a watch task and launch BrowserSync by running the npm script:
npm run watch
-
🙏 make small, single-purpose commits often with clear messages.
-
Compile the static files for production by running the npm script:
npm run prod
-
Commit all changes:
git commit -am "A clear message"
-
Push branch to Github
git push origin $feature_name
-
Squash and merge your feature branch into the develop branch.
-
Delete the feature branch.
-
Merge the
develop
branch intomaster
.
In order to fully stop the watch task and sculpin server, you need to do more than stop webpack. Once that is stopped, to the following:
sudo lsof -i tcp:8000
- get the PID of the sculpin task and make note of itkill -9 PID
- replace PID with the number from the step above
To create and deploy a new release, follow the steps outlined in the Release Doc.
We use SemVer for versioning. For the versions available, see the tags on this repository.
TODO ...list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details
A hat tip to anyone who's code was used as we've stood on the backs of giants for sure.
Like this README, this project is a WIP. It is also built with Love ❤️
Let my heart be still a moment and this mystery explore...