https://github.com/ocean-ds/ocean-web

Blu's Design System for Web
https://github.com/ocean-ds/ocean-web

a11y components design-system monorepo ocean-ds react typescript uikit

Last synced: 16 days ago
JSON representation

Blu's Design System for Web

• Host: GitHub
• URL: https://github.com/ocean-ds/ocean-web
• Owner: ocean-ds
• License: gpl-3.0
• Created: 2020-06-17T14:28:29.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-16T13:03:48.000Z (8 months ago)
• Last Synced: 2024-05-17T04:28:07.103Z (8 months ago)
• Topics: a11y, components, design-system, monorepo, ocean-ds, react, typescript, uikit
• Language: TypeScript
• Homepage: https://ocean-ds.github.io/ocean-web
• Size: 8.49 MB
• Stars: 33
• Watchers: 13
• Forks: 7
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        


  

    

  





  The design system made by Blu





  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  



This project is composed of many npm packages for building web apps with [Ocean](https://zeroheight.com/9c9b2b3aa/p/257272-ocean-ds/t/968532) design system.

## Documentation

Documentation and examples can be found [here](https://ocean-ds.github.io/ocean-web/index.html).

## Get Started

To run the project, first install the packages:

```bash

yarn install

```

Then run the project with watch:

```bash

yarn watch:storybook

```

Or run the project without watch:

```bash

yarn run storybook

```

If you changed or added CSS, run this:

```bash

yarn watch:css

```

## Packages

| Package                                              | Version                                                           | Description                                            |

| ---------------------------------------------------- | ----------------------------------------------------------------- | ------------------------------------------------------ |

| [`@useblu/ocean-core`](packages/ocean-core#readme)   | ![npm (scoped)](https://img.shields.io/npm/v/@useblu/ocean-core)  | UIkit css that implement Ocean's Design System.        |

| [`@useblu/ocean-react`](packages/ocean-react#readme) | ![npm (scoped)](https://img.shields.io/npm/v/@useblu/ocean-react) | React components that implement Ocean's Design System. |

## Contributing

Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of this project! :blue_heart: Read below to learn how you can take part of it.

### Code of Conduct

We adopted a Code of Conduct that we expect project participants to adhere to. Please read [the full text](.github/CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.

### Contributing Guide

Read our [contributing guide](.github/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes.

### Good First Issues

To help you get your feet wet and get you familiar with our contribution process, we have a list of [good first issues](https://github.com/ocean-ds/ocean-web/labels/good%20first%20issue) that contain bugs which have a relatively limited scope. This is a great place to get started.

## Join our community

Join our [discord server](https://discord.gg/hDWzGPKuG2) to get the latest updates, chat with other Ocean enthusiasts, and see what's happening in the community!

## License

All packages are licensed under the terms of the [GPL-3.0 License](LICENSE).

## Related Projects

- [Design tokens for the Blu design system](https://github.com/ocean-ds/ocean-tokens)

- [SVG icons for Ocean DS](https://github.com/ocean-ds/ocean-icons)