@spaced-out/ui-design-system 0.0.3-beta.1 → 0.0.3

package/.all-contributorsrc

@@ -0,0 +1,36 @@
+{
+  "projectName": "ui-design-system",
+  "projectOwner": "Spaced-Out",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "files": [
+    "README.md",
+    "src/stories/INTRODUCTION.stories.mdx"
+  ],
+  "imageSize": 100,
+  "commit": false,
+  "commitConvention": "react",
+  "contributors": [
+    {
+      "login": "superrover",
+      "name": "Nishant Gaurav",
+      "avatar_url": "https://avatars.githubusercontent.com/u/86281150?v=4",
+      "profile": "https://github.com/superrover",
+      "contributions": [
+        "code",
+        "doc"
+      ]
+    },
+    {
+      "login": "Anant-Raj",
+      "name": "Anant Raj",
+      "avatar_url": "https://avatars.githubusercontent.com/u/8904071?v=4",
+      "profile": "https://github.com/Anant-Raj",
+      "contributions": [
+        "code",
+        "doc"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7
+}

package/.cspell/custom-words.txt

@@ -1,6 +1,7 @@
 atleast
 circlehollow
 commitlint
+contributorsrc
 DEFAULTTEXT
 dismissable
 Fennimore
@@ -10,12 +11,14 @@ Gaurav
 Lipsey
 Neue
 Nishant
+OPACITYS
 partialformat
 premajor
 preminor
 prepatch
 rgba
 sbdocs
+superrover
 testid
 tnum
 transclude

package/.storybook/preview.js

@@ -62,8 +62,10 @@ export const parameters = {
       method: 'alphabetical',
       order: [
         'Introduction',
-        'Design Tokens',
         'Changelog',
+        'Usage',
+        'Contribution',
+        'Design Tokens',
         'Tokens',
         'Components',
         [

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### 0.0.3 (2022-11-22)
+
+
+### Bug Fixes
+
+* added new storybook pages ([2844a5e](https://github.com/Spaced-Out/ui-design-system/commit/2844a5e90cfa479268374bc8bfd4f46bc8458149))
+
 ### 0.0.3-beta.1 (2022-11-21)
 
 

package/CONTRIBUTING.md

@@ -0,0 +1,161 @@
+![Alt text](https://spaced-out.github.io/ui-design-system/images/contributions.png)
+
+# Contribution Guidelines
+
+Genesis Design System is created using:
+
+- [Gulp](https://gulpjs.com/)
+- [CSS Modules](https://github.com/css-modules/css-modules)
+- [React](https://reactjs.org/)
+
+It also features:
+
+- [Style-Dictionary](https://www.style-dictionary-play.dev/) to help you create and style variables
+- [Storybook](https://storybook.js.org/) to help you create and show off your components
+- [Standard Version](https://github.com/conventional-changelog/standard-version) to manage changelog across releases
+
+## Development
+
+<br/>
+
+### Environment Setup
+
+- Clone the repository on Github.
+
+- Run the environment locally:
+
+```bash
+#clone repository
+git clone git@github.com:Spaced-Out/ui-design-system.git
+
+#change directory to the cloned repository
+cd ui-design-system
+
+#create new branch
+git checkout -b [BRANCH_NAME]
+
+#install dependencies
+yarn install
+
+#start development server
+yarn storybook
+```
+
+> The `storybook` server runs on port **6006** and url is opened automatically on successful dev build.
+
+### Generating New Components
+
+We've included a handy NodeJS util file under `scripts` called `create-component.js`. Instead of copy pasting components to create a new component,
+you can instead run this command to generate all the files you need to start building out a new component. To use it:
+
+```bash
+yarn generate YourComponentName
+```
+
+> This will generate:
+
+```bash
+/src
+  /components
+    /YourComponentName
+      YourComponentName.jsx
+      YourComponentName.stories.jsx
+      YourComponentName.module.css
+      YourComponentName.stories.module.css
+```
+
+> The default templates for each file can be modified under `scripts/templates`.
+
+### Exports
+
+Export Component as named export and Component Props/Types e.g. export Modal from `./src/components/Modal/index.js`.
+
+### Imports
+
+We use a third party plugin to sort out imports. We use
+[eslint-plugin-simple-import-sort](https://github.com/lydell/eslint-plugin-simple-import-sort#sort-order)
+
+### Adding Stories
+
+A [story](https://storybook.js.org/docs/react/get-started/whats-a-story) captures the rendered state of a UI component. You can write multiple stories
+per component. A component story must have `.stories.jsx` extension.
+
+### Using Design Tokens
+
+Check out our [**Design Tokens Page**](https://spaced-out.github.io/ui-design-system/?path=/docs/design-tokens--page) to use tokens.
+
+### Testing Genesis Design System Locally
+
+> In the `ui_design_system` directory's run:
+
+```bash
+  yarn build
+```
+
+> In the `consumer's` directory's run:
+
+```bash
+  yarn add @spaced-out/ui-design-system@file:../../ui-design-system
+```
+
+> This would copy the genesis design system package to node modules locally and create an entry in the `consumer's` package.json
+
+```bash
+  ...
+  "dependencies": {
+    ...
+    "@spaced-out/ui-design-system": "file:../../ui_design_system",
+    ...
+  },
+  ...
+```
+
+which will install the local genesis design system library as a dependency in `consumer`.
+
+For every change in `ui_design_system` that you want to propagate to `consumer` run:
+
+> in `ui_design_system`
+
+```bash
+  yarn build
+```
+
+> in `consumer`
+
+```bash
+  yarn upgrade @spaced-out/ui-design-system@file:../../ui-design-system
+```
+
+## Commits
+
+Each commit should follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) guidelines
+
+Most commonly used commit prefixes:
+
+> `fix:` a commit of the type fix patches a bug in your codebase (this correlates with [PATCH](https://semver.org/#summary) in Semantic Versioning)
+
+> `feat:` a commit of the type feat introduces a new feature to the codebase (this correlates with [MINOR](https://semver.org/#summary) in Semantic Versioning)
+
+> `refactor:` Commits, that rewrite/restructure your code, however does not change any behavior
+
+> `style:` Commits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc)
+
+> `docs:` Commits, that affect documentation only
+
+> `build:` Commits, that affect build components like build tool, ci pipeline, dependencies, project version, etc.
+
+## Add yourself to the contributor list
+
+To add yourself to the `all-contributors` table in the README and INTRODUCTION stories:
+
+> Run the following commands from the root of the repo:
+
+```sh
+./node_modules/.bin/all-contributors add <username> <contribution>
+```
+
+> Then, you'll need to generate the updated `all-contributors` table by running
+
+```sh
+./node_modules/.bin/all-contributors generate
+```

package/README.md

@@ -1,156 +1,84 @@
-# Sense UI Component Library
+![Alt text](https://spaced-out.github.io/ui-design-system/images/usage.png)
 
-This Genesis design system is created using:
+# Genesis Design System
 
-- [Gulp](https://gulpjs.com/)
-- [CSS Modules](https://github.com/css-modules/css-modules)
-- [React](https://reactjs.org/)
+Genesis design system consists of a set of tools and protocols that unify design and development across surfaces (platforms) to deliver consistent
+user experiences. The system utilizes workflow automation to streamline the design and development process. It's comprised of a number of React
+web components that each play a unique role within the product development cycle.
 
-It also features:
+The integration of these components are intended to grow and scale overtime to increasingly decrease workflow friction and optimize the product
+development lifecycle.
 
-- [Style-Dictionary](https://www.style-dictionary-play.dev/) to help you create and style variables
-- [Storybook](https://storybook.js.org/) to help you create and show off your components
-- [Standard Version](https://github.com/conventional-changelog/standard-version) to manage changelog across releases
-
-### Commits
-
-Each commit should follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) guidelines
-
-Most commonly used commit prefixes:
-
-`fix:` a commit of the type fix patches a bug in your codebase (this correlates with [PATCH](https://semver.org/#summary) in Semantic Versioning)
-
-`feat:` a commit of the type feat introduces a new feature to the codebase (this correlates with [MINOR](https://semver.org/#summary) in Semantic Versioning)
-
-`refactor:` Commits, that rewrite/restructure your code, however does not change any behavior
-
-`style:` Commits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc)
-
-`docs:` Commits, that affect documentation only
-
-`build:` Commits, that affect build components like build tool, ci pipeline, dependencies, project version, etc.
-
-### Building
-
-```
-yarn build
-```
-
-To Build the style variables using style-dictionary run
-
-```
-yarn build:style-variables
-```
-
-It would put all the style variables created inside the styles folder. Our yarn build hook would essentially copy these variables to the build output target.
-
-### Storybook
-
-To run a live-reload Storybook server on your local machine:
-
-```
-yarn storybook
-```
-
-To export your Storybook as static files:
-
-```
-yarn storybook:export
-```
-
-After merging PR in master, storybook gets updated at https://spaced-out.github.io/ui-design-system/
-
-### Generating New Components
-
-We've included a handy NodeJS util file under `scripts` called `create-component.js`. Instead of copy pasting components to create a new component, you can instead run this command to generate all the files you need to start building out a new component. To use it:
-
-```
-yarn generate YourComponentName
-```
-
-This will generate:
-
-```
-/src
-  /components
-    /YourComponentName
-      YourComponentName.jsx
-      YourComponentName.stories.jsx
-      YourComponentName.module.css
-      YourComponentName.stories.module.css
-```
-
-The default templates for each file can be modified under `scripts/templates`.
-
-### Installing Sense UI Component Library in ui_server Locally
-
-In the `ui_design_system` directory's run:
-
-```
-  yarn build
-```
-
-In the `consumer's` directory's run:
-
-```
-  yarn add @spaced-out/ui-design-system@file:../../ui-design-system
-```
+## Usage
 
-This would copy the design system package to node modules locally and create an entry in the `consumer's` package.json
+To install `@spaced-out/ui-design-system` in your project, you will need to run the
+following command using [yarn](https://yarnpkg.com/):
 
-```
-  ...
-  "dependencies": {
-    ...
-    "@spaced-out/ui-design-system": "file:../../ui_design_system",
-    ...
-  },
-  ...
+```bash
+yarn add @spaced-out/ui-design-system
 ```
 
-which will install the local component library as a dependency in `consumer`.
+Usage of the component (after the library installed as a dependency in project) will be:
 
-For every change in `ui_design_system` that you want to propagate to `consumer` run:
+```js
+import React from 'react';
+import {Button} from '@spaced-out/ui-design-system/lib/components/Button';
 
-in `ui_design_system`
+const App = () => (
+  <div className="app-container">
+    <Button>Hello world</Button>
+  </div>
+);
 
-```
-  yarn build
+export default App;
 ```
 
-in `consumer`
+For more information about each component, check out
+[Storybook](https://spaced-out.github.io/ui-design-system).
 
-```
-  yarn upgrade @spaced-out/ui-design-system@file:../../ui-design-system
-```
-
-## Usage
+**&rarr; Fonts**
 
-Let's say you created a public NPM package called `@spaced-out/ui-design-system` with the `Button` component created in this repository.
+By default Genesis uses `'Centra No 2'` font. To add this font in your project you need to load this font. The recommended way to do it is by adding the following in your global css.
 
-Usage of the component (after the library installed as a dependency into another project) will be:
-
-```JSX
-import React from "react";
-import { Button } from "@spaced-out/ui-design-system/lib/components/Button";
+```css
+@font-face {
+  font-family: 'Centra No 2';
+  src: url('https://s3.us-west-2.amazonaws.com/assets.sensehq.com/type/CentraNo2-Book.woff2')
+      format('woff2'), url('https://s3.us-west-2.amazonaws.com/assets.sensehq.com/type/CentraNo2-Book.woff')
+      format('woff');
+  font-weight: 300 400;
+  font-style: normal;
+  font-display: auto;
+}
 
-const App = () => (
-  <div className="app-container">
-    <h1>Hello I'm consuming the component library</h1>
-    <Button>Hello world</Button>
-  </div>
-);
+@font-face {
+  font-family: 'Centra No 2';
+  src: url('https://s3.us-west-2.amazonaws.com/assets.sensehq.com/type/CentraNo2-BookItalic.woff2')
+      format('woff2'), url('https://s3.us-west-2.amazonaws.com/assets.sensehq.com/type/CentraNo2-BookItalic.woff')
+      format('woff');
+  font-weight: 300 400;
+  font-style: italic;
+  font-display: auto;
+}
 
-export default App;
+@font-face {
+  font-family: 'Centra No 2';
+  src: url('https://s3.us-west-2.amazonaws.com/assets.sensehq.com/type/CentraNo2-Medium.woff2')
+      format('woff2'), url('https://s3.us-west-2.amazonaws.com/assets.sensehq.com/type/CentraNo2-Medium.woff')
+      format('woff');
+  font-weight: 500;
+  font-style: normal;
+  font-display: auto;
+}
 ```
 
-### Using Component Library Design Tokens
+**&rarr; Using Genesis Design Tokens**
 
-Design tokens are exported `.css` and `.js`. You can consume them easily by
+Design tokens are exported as `.css` and `.js`. You can consume them easily by
 
 CSS use:
 
-```CSS
+```js
 @value (size2) from '@spaced-out/ui-design-system/lib/styles/variables/_size.css';
 
 .example-container {
@@ -160,8 +88,34 @@ CSS use:
 
 JS use:
 
-```JSX
+```js
 import size2 from "@spaced-out/ui-design-system/lib/styles/variables/_size.js";
 import * as SIZES from "@spaced-out/ui-design-system/lib/styles/variables/_size.js";
-
 ```
+
+## Documentation
+
+- [Storybook](https://spaced-out.github.io/ui-design-system)
+
+## Contributions
+
+Check out our [**Contribution Guide**](https://spaced-out.github.io/ui-design-system/?path=/docs/contribution--page) to setup and contribute to Genesis.
+
+## Maintainers ✨
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/superrover"><img src="https://avatars.githubusercontent.com/u/86281150?v=4?s=100" width="100px;" alt="Nishant Gaurav"/><br /><sub><b>Nishant Gaurav</b></sub></a><br /><a href="https://github.com/Spaced-Out/ui-design-system/commits?author=superrover" title="Code">💻</a> <a href="https://github.com/Spaced-Out/ui-design-system/commits?author=superrover" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Anant-Raj"><img src="https://avatars.githubusercontent.com/u/8904071?v=4?s=100" width="100px;" alt="Anant Raj"/><br /><sub><b>Anant Raj</b></sub></a><br /><a href="https://github.com/Spaced-Out/ui-design-system/commits?author=Anant-Raj" title="Code">💻</a> <a href="https://github.com/Spaced-Out/ui-design-system/commits?author=Anant-Raj" title="Documentation">📖</a></td>
+    </tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->

package/cspell.json

@@ -7,7 +7,10 @@
     "storybook-static",
     ".vscode",
     "CHANGELOG.md",
-    ".storybook/public"
+    ".storybook/public",
+    ".all-contributorsrc",
+    "README.md",
+    "src/stories/INTRODUCTION.stories.mdx"
   ],
   // Enable your dictionary by adding it to the list of `dictionaries`
   "dictionaries": ["custom-words"],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spaced-out/ui-design-system",
-  "version": "0.0.3-beta.1",
+  "version": "0.0.3",
   "main": "index.js",
   "description": "Sense UI components library",
   "author": {
@@ -100,7 +100,8 @@
     "standard-version": "^9.5.0",
     "storybook-css-modules": "^1.0.8",
     "storybook-vscode-component": "^1.0.8",
-    "style-dictionary": "^3.7.1"
+    "style-dictionary": "^3.7.1",
+    "all-contributors-cli": "^6.20.0"
   },
   "husky": {
     "hooks": {