studio/cunningham
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

📝(doc) update docs to install published packages + contributing guide

Browse Source 
Updated various parts of existing documentations to make a clean path
to learn how to install the library. I let the most complicated part in
the tokens's README.md file, which is referenced from the Storybook.
This commit is contained in:
Nathan Vasse
2023-01-30 15:00:46 +01:00
committed by NathanVss
parent 4ebbf168e2
commit 63118d0f3e
5 changed files with 1216 additions and 741 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@@ -1,53 +1,20 @@
# Cunningham, the best OpenSource Design System
# 🎨 Cunningham, the best OpenSource Design System
[![CircleCI](https://circleci.com/gh/openfun/cunningham/tree/master.svg?style=svg)](https://circleci.com/gh/openfun/richie/tree/master)
<p align="center">
<a href="https://openfun.github.io/cunningham"><b>Documentation</b></a> •
<a href="https://www.figma.com/file/sSEMhow3g5zpEkyDLEQ1ZO/DS-Cunningham?node-id=47%3A261&t=nKRnadK4sslyVxD7-0"><b>Figma</b></a>
<a href="https://openfun.github.io/cunningham"><b>📚&nbsp;&nbsp;Documentation</b></a> •
<a href="https://www.figma.com/file/sSEMhow3g5zpEkyDLEQ1ZO/DS-Cunningham?node-id=47%3A261&t=nKRnadK4sslyVxD7-0"><b>🖌️&nbsp;&nbsp;Figma</b></a>
</p>
## Getting started
Packages are not published yet, but once it is done we will show people how to install packages.
## Development
### First start
Install and build packages
```
make bootstrap
```
And then run dev servers
```
make dev
```
Then, you will be able to access the demo app on `http://localhost:3200` and the React components package's Storybook on
`http://localhost:6006`
### Building
In order to build all packages of this repo you just need to type the following command at the root of the monorepo.
```
make build
```
Everything is detailed on our [documentation](https://openfun.github.io/cunningham). 📚
## Contributing
This project is intended to be community-driven, so please, do not hesitate to
get in touch if you have any question related to our implementation or design
decisions.
We try to raise our code quality standards and expect contributors to follow
the recommandations from our
[handbook](https://openfun.gitbooks.io/handbook/content).
Please see our [contributing guidelines](./CONTRIBUTING.md).
## License