Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cityofdetroit/cod-design-system
Design System proof of concept
https://github.com/cityofdetroit/cod-design-system
design-system web-components
Last synced: 3 months ago
JSON representation
Design System proof of concept
- Host: GitHub
- URL: https://github.com/cityofdetroit/cod-design-system
- Owner: CityOfDetroit
- License: mit
- Created: 2022-11-17T23:26:05.000Z (about 2 years ago)
- Default Branch: dev
- Last Pushed: 2024-05-21T16:36:44.000Z (9 months ago)
- Last Synced: 2024-05-22T14:34:30.540Z (9 months ago)
- Topics: design-system, web-components
- Language: JavaScript
- Homepage: https://cityofdetroit.github.io/COD-Design-System/
- Size: 104 MB
- Stars: 1
- Watchers: 3
- Forks: 2
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# COD-Design-System
Design System proof of concept
## Getting Started
This project was created using:
- [Webpack](https://webpack.js.org/) as a web application bundler.
- [Yarn](https://classic.yarnpkg.com/en/) to manage project dependencies.
- [MapLibre](https://maplibre.org/) for map framework.
- [Storybook](https://storybook.js.org/) for UI component management.
## Using in Your Project
1. Load package into your project
```
yarn add @cityofdetroit/cod-design-system
```
```
npm i @cityofdetroit/cod-design-system
```
## Contributing
### Setup Local Environment
1. Download the repo.
```
$ git clone [email protected]:jedgar1mx/COD-Design-System.git
```
2. Install node dependencies.
```
$ yarn
```
3. Run local instance.
```
$ yarn storybook
```
4. Build storybook.
```
$ yarn build-storybook
```
### Testing
Use Storybooks [built-in test-runner](https://storybook.js.org/docs/react/writing-tests/test-runner):
1. Run a local instance of storybook in one process.
2. Invoke the test runner in another. Note: depending on the power of you machine, you may have to reduce concurrent workers to avoid test timeout failures. Use `--maxWorkers=2` to limit the workers to two.
```
$ yarn test-storybook
```
### Formatting and Linting
The remote repository will enforce ESLint rules and Prettier formatting.
To check ESLint and Prettier formatting locally:
```
$ yarn lint
```
To format the code in `./src/`:
```
$ yarn prettier -w ./src
```