@carletonuniversity/rds v0.9.9
Raven Design System
Raven Design System, better known as RDS, is Carleton University’s design system, is a living digital organism uniting campus wide teams around a common visual language.
Build Tools
Getting Started
In a terminal window open your install location and run the following:
git clone https://github.com/cuweb/rds.git
Once the clone is complete move into the
RDS
directory and run:npm install
Run Storybook
npm run storybook
Other useful shell commands
npm run rebuild
- deletes node modules, package lock and run npm installnpm run format
- format files with prettiernpm run lint
- check for errors with eslintnpm run size
- compare compiled size against pre-defined limit
Comment Linting
When adding a commit with a commit you may be blocked if you do not prefix your comment with one of the following types. So a commit should look like: git commit -m "change: updated spacing around button"
. The prefix requires a colon to separate it from the comment.
add
- used when adding something new such as a component, story or test filechange
- used when making a change to an existing file in the projectdeprecate
- used when deprecating codedoc
- used when updating something related to documentationfix
- used when fixing an error, warning or something elsefinish
- used when finishing a feature or fixrefactor
- used when refactoring something such as a component or build toolrelease
- used when preparing a new releaserevert
- used when revert to a past committest
- used when making changes relating to testingupgrade
- used when upgrading packages
Deployment
This project is available as an NPM Package.
How to use in a project
Install the package using one of the following command:
yarn add @carletonuniversity/rds npm install @carletonuniversity/rds
Import the css file into your primary css file using:
/* primarycssfile.css */ @import '../node_modules/@carletonuniversity/rds/dist/index.css';
OR
/* primarycssfile.css */ @import '~@carletonuniversity/rds/dist/index.css';
15 days ago
19 days ago
20 days ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
10 months ago
10 months ago
10 months ago
10 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
10 months ago
10 months ago
10 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
10 months ago
9 months ago
9 months ago
7 months ago
7 months ago
7 months ago
7 months ago
9 months ago
7 months ago
7 months ago
6 months ago
7 months ago
7 months ago
7 months ago
7 months ago
6 months ago
6 months ago
10 months ago
10 months ago
11 months ago
10 months ago
10 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
12 months ago
12 months ago
11 months ago
11 months ago
11 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago