@world-vision-canada/lumen-css
Advanced tools
Comparing version 0.0.3 to 0.0.4-dev.26
{ | ||
"name": "@world-vision-canada/lumen-css", | ||
"version": "0.0.3", | ||
"version": "0.0.4-dev.26", | ||
"description": "CCS implementation of WVC's Lumen Design System. Intended to be imported into js framework(vue, react) implementation of lumen and wvc websites.", | ||
@@ -18,3 +18,4 @@ "main": "wvc-lumen.min.css", | ||
"storybook": "start-storybook -p 6001", | ||
"build-storybook": "build-storybook" | ||
"build-storybook": "build-storybook", | ||
"chromatic": "npx chromatic --project-token=517e408ff37e --exit-once-uploaded" | ||
}, | ||
@@ -32,2 +33,3 @@ "devDependencies": { | ||
"babel-loader": "^8.2.3", | ||
"chromatic": "^6.0.6", | ||
"css-loader": "5.2.7", | ||
@@ -34,0 +36,0 @@ "sass": "^1.43.4", |
# WVC Lumen CSS # | ||
CCS implementation of WVC's Lumen Design System. Intended to be imported into js framework(vue, react) implementation of lumen and wvc websites. | ||
CCS implementation of WVC's Lumen Design System. | ||
## Running the Project | ||
## Documentation | ||
- https://worldvisioncanada.atlassian.net/wiki/spaces/SYS/pages/3039363073/Lumen+CSS | ||
## Project commands | ||
- To download project dependecies, run `yarn`. | ||
- To run the storybook sandbox, run `yarn start`. | ||
- To compile scss to css for deployment(to dist/), run `yarn build`. | ||
- To lint (error check) your code, run `yarn lint`. | ||
## Getting Started | ||
### Using inside an HTML project | ||
In the `<head>` place: | ||
``` | ||
<link rel="stylesheet" href="https://unpkg.com/@world-vision-canada/lumen-css@*.*.*/wvc-lumen.min.css"> | ||
``` | ||
Replace `@*.*.*` with the correct version number if needed. | ||
Apply component classes to existing markup or copy component snippets from storybook. | ||
`<button class="wvc-btn wvc-btn--primary theme-light">Button</button>` | ||
### Import to js framework project (vue, react) | ||
- Download package, run `npm i @world-vision-canada/lumen-css` or `yarn add @world-vision-canada/lumen-css`. | ||
- Import css file at app's entry point | ||
``` | ||
import "@world-vision-canada/lumen-css/wvc-lumen.min.css"; | ||
``` | ||
- apply component classes to existing markup or copy component snippets from storybook. | ||
`<button class="wvc-btn wvc-btn--primary theme-light">Button</button>` | ||
*** | ||
### What is this repository for? ### | ||
* Quick summary | ||
* Version | ||
* [Learn Markdown](https://bitbucket.org/tutorials/markdowndemo) | ||
### How do I get set up? ### | ||
* Summary of set up | ||
* Configuration | ||
* Dependencies | ||
* Database configuration | ||
* How to run tests | ||
* Deployment instructions | ||
### Contribution guidelines ### | ||
* Writing tests | ||
* Code review | ||
* Other guidelines | ||
### Who do I talk to? ### | ||
* Repo owner or admin | ||
* Other community or team contact | ||
- To lint (error check) your code, run `yarn lint`. |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
27355
442
15
12