Skip to content

Cambly/syntax

Repository files navigation

Syntax - Cambly's design system · NPM Version License

Setup

# Install nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
# Install node
nvm install
# Install dependencies
npm install -g pnpm@9.4.0
pnpm install
# Run the dev server
pnpm start

Syntax-Icons: Generate new Icons:

  1. Update @syntax-icons/svgs folder with new icons.
  2. Run pnpm run generate-icons
  3. If you added a new Icon
  • Add it into the Icons.stories.tsx and update the array.
  • Update the syntax-icons/package.json with the proper export.
  1. Run pnpm run changeset

Generate a new React Component

  1. Run pnpm generate ComponentName
  2. Update newly generated files.
  3. (Don't forget to StartCase your ComponentName)

Usage guidelines

https://docs.google.com/document/d/1zXAR4Lz0M_--SluTlEUpGUW16TpWWaZNh5h39cU3gQk/edit

Contribute

  1. Fork the syntax repository
  2. Create a new branch:
  3. Make your changes: git commit -am "Avatar: add component"
  4. Add a changeset with pnpm changeset
  5. Open a pull request

Acknowledgements