shine design

---

UI design language for developers, designers and product managers

Preview

Shine Design is about to usher in a major update, and the new version (2.0) will bring a more comprehensive component system and a richer style choice. Please look forward to it!

• Newly supported Typescript and output multiple versions of component libraries.
• A brand new视觉and交互design solution provides visualization tools to achieve a wide range of people in different businesses.
• The number of components has increased significantly and will be expanded to 30+ components.
• React version upgrade, supports brand new syntax.

Good things are worth waiting for.

Functional Features

• High-quality components out of the box, providing developers, designers and product managers with rich ideas and ideas.
• Compatible with most mainstream browsers such as IE, Chrome and Firefox, it brings a unified visual experience to users.
• It has a full-link development and design tool system, which is permanently free.

Quickly build

It is recommended to use the quick build tool Shined CLI to build a project, just execute it in turn:

For specific usage of the build tool, please refer to the build tool description.

Example of usage

Getting started with Shine Design is easier than you think, you just need to do the following :

We provide a wealth of components for developers to view component documentation.

Debugging and Deployment

The rapid construction tool has integrated one-click debugging and deployment instructions. You can implement debugging and deployment in the development environment and production environment by simply executing the following commands:

After starting debugging in the development environment, open http://127.0.0.1:3000 in the browser to view the effect.

Update log

You can get relevant version information from the update log.

Release cycle

This project update is carried out in accordance with the Semantic Versioning 2.0.0 standard:

• Revision: One weekly revision for daily bug fixes (non-emergency).
• Secondary version number: A secondary version is released every two days, and the secondary version update will be backward compatible with the current major version.
• Major version number: Major iteration work, non-periodic updates, incompatible with historical major versions.

Get help

If you encounter problems during use, you can seek help through the following ways:

• We provide detailed component documentation, and most of the problems can be solved in the documentation.
• With the powerful Issue feature, you can ask questions directly, we will follow and answer questions at any time. At the same time, we also encourage senior users to help newcomers through Issue.

Participate in the project

We look forward to your participation in the development :), but we hope you can abide by the relevant agreements:

• We have a code of conduct that we hope all contributors can follow, please take the time to read the full text to make sure you understand what can be done and what can’t be done.
• Based on our release cycle, we cut a release branch from master branch every week. The naming rule is generally release-版本号, such as release-1.0.0 version 1.0.0 that is about to be released. If you have made a bug fix, please directly pull Request to the current release branch. If you are doing new features development, please pull Request to master branch.
• If you have good ideas, we also welcome you to tell us directly through Issue.

Contact Us

If you need to contact us, you can send an email to [email protected].

License

This project is based on MIT license open source.