Skip to content

ocean-ds/ocean-web

The design system made by Blu

Actions Status Sonarcloud Status GitHub License GitHub last commit Dependabot Prettier code style Lerna Conventional Commits Conventional Commits Discord Server

This project is composed of many npm packages for building web apps with Ocean design system.

Documentation

Documentation and examples can be found here.

Get Started

To run the project, first install the packages:

yarn install

Then run the project with watch:

yarn watch:storybook

Or run the project without watch:

yarn run storybook

If you changed or added CSS, run this:

yarn watch:css

Packages

Package Version Description
@useblu/ocean-core npm (scoped) UIkit css that implement Ocean's Design System.
@useblu/ocean-react npm (scoped) 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! 💙 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 so that you can understand what actions will and will not be tolerated.

Contributing Guide

Read our contributing guide 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 that contain bugs which have a relatively limited scope. This is a great place to get started.

Join our community

Join our discord server 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.

Related Projects