# @octopusthink/nautilus > Nautilus design system for React Latest version **0.6.0** (published 2022-04-22) · MIT license · 0 weekly downloads ## Install ```sh npm install @octopusthink/nautilus pnpm add @octopusthink/nautilus yarn add @octopusthink/nautilus bun add @octopusthink/nautilus ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.6.0 | | Published | 2022-04-22 | | First published | 2019-06-06 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 10 | | Unpacked size | 718.6 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 2 | | Author | Octopus Think | | Maintainers | tofumatt, sarahmonster | ## Links - npm: https://www.npmjs.com/package/@octopusthink/nautilus - Repository: https://github.com/octopusthink/nautilus - Homepage: https://github.com/octopusthink/nautilus#readme - Issues: https://github.com/octopusthink/nautilus/issues - npm.io page: https://npm.io/package/@octopusthink/nautilus ## Dependencies (10) - [shx](https://npm.io/package/shx.md) ^0.3.3 - [shortid](https://npm.io/package/shortid.md) ^2.2.16 - [chroma-js](https://npm.io/package/chroma-js.md) ^2.1.2 - [invariant](https://npm.io/package/invariant.md) ^2.2.4 - [react-use](https://npm.io/package/react-use.md) ^17.3.2 - [classnames](https://npm.io/package/classnames.md) ^2.3.1 - [prop-types](https://npm.io/package/prop-types.md) ^15.7.2 - [react-select](https://npm.io/package/react-select.md) ^4.3.1 - [feather-icons](https://npm.io/package/feather-icons.md) ^4.28.0 - [@reach/combobox](https://npm.io/package/@reach/combobox.md) ^0.16.3 ## Recent versions - 0.6.0 (latest) — 2022-04-22 - 0.5.7 — 2022-04-10 - 0.5.6 — 2022-02-12 - 0.5.5 — 2022-02-12 - 0.5.4 — 2022-02-12 - 0.5.3 — 2022-02-12 - 0.5.2 — 2022-02-12 - 0.5.1 — 2022-02-11 - 0.5.0 — 2021-10-23 - 0.4.3 — 2021-10-03 - 0.4.2 — 2021-10-03 - 0.4.1 — 2021-03-01 - 0.3.0 — 2019-08-09 - 0.2.0 — 2019-07-08 - 0.1.0 — 2019-06-06 ## README [![Build Status](https://github.com/octopusthink/nautilus/workflows/Tests/badge.svg?branch=master)](https://github.com/octopusthink/nautilus/actions) [![npm version](https://badge.fury.io/js/%40octopusthink%2Fnautilus.svg)](https://www.npmjs.com/package/@octopusthink/nautilus) # Nautilus Design System Nautilus is an open-source design system and component library to help designers and developers build better digital products together. ❤️ - Designed for accessibility and usability. - Flexible theming and customisation. - Clear guidelines and extensive documentation. - Focused on consistency, ease of use, and scalability. Nautilus is available both as a Sketch library and an `npm` package for use in React projects. ## Project status Nautilus is currently pre-pre-pre-beta software. You can feel free to use it in your projects, but be warned that the API is likely to change and things may work in unexpected ways. Point releases are distributed to `npm` on the 5th of every month. You can see our near-term plans and upcoming components in the [Project](https://github.com/octopusthink/nautilus/projects) tab. - Design principles & guidelines (in progress 🛠) - Design tokens (in progress 🛠) - Accessible React components (in progress 🛠) - React Native components (planned 💡) - Sketch library (in progress 🛠) - Figma library (planned 💡) - Brand tokens and theme-ability (planned 💡) - Automated theme generation (planned 💡) ## Usage Want to use Nautilus in your next web app? Well: don't! It's much too early and it's nowhere near ready for production usage. Check back later. 😅 You can _technically_ install it from NPM, but you can't say we didn't warn you! ```bash npm install @octopusthink/nautilus ``` ## Development Want to contribute to Nautilus, or test it locally? Here's how! ### Prerequisites - `node` (LTS) - `npm` ### Installing Clone the repo: ```bash git clone https://github.com/octopusthink/nautilus.git ``` Navigate into the directory: ```bash cd nautilus ``` Install the dependencies: ```bash npm install ``` And use `npm` to compile files, watch for changes, and build the styleguide: `npm start` This will start a server for the styleguide at and watch for any changes. You'll need to restart `npm` if you make changes to `styleguide.config.js`, but otherwise you should be good to go! ## Running the tests We use `jest` to run our unit tests. If you've made changes, `jest` will only run tests on files related to your changes: ```bash npm test ``` ### Linting We lint our code using `eslint` and `prettier`. You can check your changes for linting violations with: ```bash npm run lint ``` ## Built With - [React](https://reactjs.org/) - Making JavaScript simultaneously modern and also more like HTML since 1998. - [React Styleguidist](https://react-styleguidist.js.org) - Is your styleguide running? You'd better go catch it! - [Feather](https://feathericons.com/) - The prettiest open-source icons in town. ## Contributing Please read (`CONTRIBUTING.md`) for details on our code of conduct and the process for submitting pull requests. We use the [Conventional Commits](https://www.conventionalcommits.org/) specification for commit messages to ensure that commit messages are written in a consistent and predictable way. ## Versioning We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [releases page](https://github.com/octopusthink/nautilus/releases). ## Authors - **sarah semark** - *CDO (Chief Design Octopus)* - [@sarahmonster](https://github.com/sarahmonster) - **Matthew Riley MacPherson** - *CTO (Chief Technical Octopus)* - [@tofumatt](https://github.com/tofumatt) See also the list of [contributors](https://github.com/octopusthink/nautilus/contributors) who participated in this project. ## License This project is licensed under the MIT License - see the [LICENSE.txt](LICENSE.txt) file for details. ## Acknowledgments Nautilus has been heavily inspired by, and borrows from: - [Ether](https://ether.thescenery.co/) - [GOV.UK Design System](https://design-system.service.gov.uk/) - [Carbon](https://www.carbondesignsystem.com) - [Polaris](https://polaris.shopify.com) - [Material Design](https://material.io/design/) - [Inclusive Components](https://inclusive-components.design/) --- _Source: https://npm.io/package/@octopusthink/nautilus · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._