nimiiiii / nimi-elements

Monorepo for Nimi project UI elements and utilities

Nimi Elements

Welcome aboard! This is the monorepo for various component and utility libraries primarily designed for Nimi, but also can be used in your projects.

Packages

@nimiiiii/nimi-icons

Azur Lane icons (e.g. nations) as SVG, PNG, WEBP or React components

Watch this space!

Contributing

We are very open to contributions such as feature suggestions and pull requests! There are things to take note before doing so however.

Before you submit a pull request and to ensure you have a smooth time in developing and improving the project, use Visual Studio Code or any other editor that supports syntax highlighting and linting. Make sure to install the recommended extensions as well!

If you found something that isn't right, want to ask a question, or have a suggestion you'd like to be added, then please do make a new issue.

Development scripts

Nimi Elements is organized as a monorepo using Lerna. Useful scripts include:

yarn bootstrap

Installs package dependencies and links packages together, using Lerna

yarn build

Build all workspace packages, each member must have a build npm script

yarn test

Run tests for the whole workspace, each member must have a test npm script

yarn storybook

Run Storybook for the whole workspace, importing any *.stories.tsx file, must be used after running yarn build

yarn build-storybook

Build Storybook SPA for production

Credits

All packages are Copyright © Tom Bazarnik, Nathan Alo and Ayane Satomi. Licensed under GNU General Public License v2.0 w/Classpath exception.

Azur Lane, the game, and all its assets are Copyright © Yostar. The developers and contributors are no way affiliated with the game, the company, nor its partners.

"Philosophy Sensei Z23" art by しるこ on pixiv