Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/generoi/genero-design-system
https://github.com/generoi/genero-design-system
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/generoi/genero-design-system
- Owner: generoi
- License: mit
- Created: 2020-05-11T15:38:06.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-22T15:43:58.000Z (over 1 year ago)
- Last Synced: 2024-07-23T09:36:56.085Z (2 months ago)
- Language: SCSS
- Homepage: https://gds.generogrowth.com/
- Size: 22 MB
- Stars: 4
- Watchers: 11
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Genero Design System
## Usage
### In vanilla project
Using lazy loaded ES modules.
```html
import { applyPolyfills, defineCustomElements } from 'https://unpkg.com/genero-design-system/loader/index.js'
applyPolyfills().then(() => {
defineCustomElements()
})
button
```
### In React projects
Install GDS to you project.
```sh
npm install genero-design-system
```
Add this to React App's `index.js` file. More info https://stenciljs.com/docs/react
```js
// Include global GDS css with css variables.
import 'genero-design-system/dist/gds/gds.css'
import { applyPolyfills, defineCustomElements } from 'genero-design-system/loader'
// applyPolyfills for Edge and IE11.
applyPolyfills().then(() => {
defineCustomElements()
})
```
Use as React components.
```js
import { GdsButton } from 'genero-design-system/react'
const render = () => {
return button
}
```
Use as web components.
```js
import React from 'react'
const render = () => {
return
button
}
```
### SASS library
There's no main entrypoint for all mixins, you are instead encouraged to encapsulate all dependencies in the files that they are used.
```scss
// Import component
@use '~genero-design-system/src/components/gds-button' as button;
.button {
@include button.base;
}
```
## Development
```sh
npm install
```
Build and watch changes. Also checks dependencies for updates.
```sh
npm start
```
Run storybook
```sh
npm run storybook
```
### Creating a new component
Use the `gds-button` component as a basis for the new component.
Use Stencil CLI to generate a new component:
- Component naming example: `gds-my-component`
- Skip test files for now. We need to think about those later.
```sh
npm run generate
```
Next do the following:
- Copy `gds-button/_index.scss` the the new component's folder.
- Rename the stylesheet from .css to .scss and use the `gds-button.scss` as a basis.
- Add a component.stories.js file.
- Add a README.md file
Build and watch the component and generate readme.md docs.
TODO: This should also watch changes in \_index.scss files.
```sh
npm run start
```
### Style Guide
While we don't have our internal Style Guide, let's use the same as Stencil core team: https://stenciljs.com/docs/style-guide
#### CSS
- CSS variables should be used broadly in every component.
- Naming scheme for variables is `--component-name-size-property-modifier`.
- Use SASS variables for arbitrary values.
### Docs
- Web Components Best Practices from Google: https://developers.google.com/web/fundamentals/web-components/best-practices
- On Properties: https://stenciljs.com/docs/properties
- On Shadow DOM: https://developers.google.com/web/fundamentals/web-components/shadowdom
### Build Storybook
Build static storybook to /docs folder.
```sh
npm run build
npm run build:storybook
```
You can test static version locally.
```sh
npx http-server docs
```
The storybooks are automatically built on commits to `master` and when versions are tagged. For now you'll need to edit the[`docs/storybook-config.json`](https://github.com/generoi/genero-design-system/blob/gh-pages/docs/storybook-config.json) file and add versions you want to be displayed. _TODO: this should be done with a script in the github action._
If you want to manually add a version to the storybooks docs:
```sh
# Build the storybook
npm run build
npm run build:storybook
# Clone the gh-pages branch
git clone --single-branch -b gh-pages [email protected]:generoi/genero-design-system.git gds-gh-pages
cd gds-gh-pages
cp -r ../docs docs/my-custom-build
# Edit the storybook.config.json to include the version
vim docs/storybook.config.json
```
### Tips, tricks, and gotchas
Please add here, when you solve something you got stuck at.
- In HTML, attributes need to use dash-case. In JSX you use camelCase.
- When you add new components, it's best to restart build watcher because it usually breaks here.
- Use `/public` folder for static assets in stories.
- Use `/.storybook/preview-head.html` to inject code to all stories globally.
- Sometimes changes won't reflect in Storybook. If nothing helps try to build with `npm run build:stencil --watch`.
In React apps:
- When using Stencil component without shadow DOM (`shadow: false`) in a React app, you need to use a unique key for components that are re-rendered when state changes.
### Storybook roadmap
- Add props table: https://github.com/storybookjs/storybook/tree/next/addons/docs/web-components#props-tables
### Commits
Commits will be linted according to [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
you can also use [commitizen](https://commitizen.github.io/cz-cli/)
```sh
npx git-cz
```
or if you have it installed
```sh
git cz
```
### Using local version of GDS in other projects
You can use linking to use GDS local repo in other project directly.
Go to GDS local repo.
```sh
yarn link
```
Go to you project where you want to use GDS directly.
```sh
yarn link genero-design-system
```
Presto!
## Publishing a new version
### Build first
Make sure everything is built.
```sh
npm run build
```
### Create release
Automatically generates changelog and bumps the version.
Bump minor (or patch or major) version:
```sh
npm run release -- --release-as minor
```
or based on commit log:
```sh
npm run release
```
or manually specify the version:
```sh
npm run release -- --release-as 1.1.0
```
or a named prerelease version:
```sh
npm run release -- --prerelease beta
```
Push release commit and tag.
```sh
git push
git push --tags
```
See [conventional-changelog/standard-version#cli-usage](https://github.com/conventional-changelog/standard-version#cli-usage) for more details and examples
### Publish release to NPM
```sh
npm login
npm publish
```