forked from sombochea/verdaccio-ui
d554049699
* fix: engine warning on console for ui * chore: update snapshots * chore: remove u flag * chore: add readme note * chore: update README.md Co-Authored-By: Daniel Ruf <827205+DanielRuf@users.noreply.github.com> Co-authored-by: Daniel Ruf <827205+DanielRuf@users.noreply.github.com>
107 lines
5.7 KiB
Markdown
Executable File
107 lines
5.7 KiB
Markdown
Executable File
|
|
|
|
|
|
# Version 4 UI Theme
|
|
|
|
[Verdaccio](https://verdaccio.org/) UI is a [theme plugin](https://verdaccio.org/docs/en/dev-plugins#theme-plugin) build in React, Flow and Emotion. It uses Jest and Enzyme for Unit testing.
|
|
|
|
|
|
[](https://www.npmjs.com/package/@verdaccio/ui-theme)
|
|
[](https://verdaccio.org/docs/en/docker.html)
|
|
[](https://opencollective.com/verdaccio)
|
|
[](https://stackshare.io/verdaccio)
|
|
[](http://chat.verdaccio.org/)
|
|
[](https://www.npmjs.com/package/@verdaccio/ui-theme)
|
|
|
|
[](https://crowdin.com/project/verdaccio)
|
|
[](https://codecov.io/gh/verdaccio/ui)
|
|
|
|
|
|
[](https://twitter.com/verdaccio_npm)
|
|
[](https://github.com/verdaccio/verdaccio/stargazers)
|
|
|
|
## Contributing
|
|
|
|
We use `>=yarn@1.13.0`, keep in mind that we use lockfiles and use at least Node `v10.13.0` to be able to build the project.
|
|
|
|
For development run the following command, it will execute `webpack` and `verdaccio` to
|
|
|
|
```bash
|
|
yarn dev
|
|
```
|
|
The configuration file is located on `tools/_config.yaml`.
|
|
|
|
Run linting tooling and test to check your code is clean before commit.
|
|
|
|
> ⚠️ The development mode just emulate interaction of the UI development with a real verdaccio server, but it is not the real integration. UI is just a theme plugin dependency in the [Verdaccio project](https://github.com/verdaccio/verdaccio).
|
|
|
|
### Before commit
|
|
|
|
Don't forget run the following commands before commit and push your code, it will save you time.
|
|
|
|
```bash
|
|
yarn lint && yarn test
|
|
```
|
|
|
|
#### Commits
|
|
|
|
Remember we follow the [the Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0-beta.4/).
|
|
|
|
🤓 Feel free to participate in code reviews, let us know if you want to participate in this plugin.
|
|
|
|
### End to End Testing
|
|
|
|
Additionally, we recommend run E2E testing before push and verify your changes do not break anything. These command will run in our CI anyway.
|
|
|
|
```bash
|
|
yarn build && yarn test:e2e
|
|
```
|
|
|
|
> `yarn build` will build with webpack the production files.
|
|
|
|
|
|
## Open Collective Sponsors
|
|
|
|
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/verdaccio#sponsor)]
|
|
|
|
[](https://opencollective.com/verdaccio/sponsor/0/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/1/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/2/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/3/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/4/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/5/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/6/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/7/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/8/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/9/website)
|
|
|
|
## Open Collective Backers
|
|
|
|
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/verdaccio#backer)]
|
|
|
|
[](https://opencollective.com/verdaccio#backers)
|
|
|
|
## Contributors
|
|
|
|
This project exists thanks to all the people who contribute.
|
|
|
|
[](../../graphs/contributors)
|
|
|
|
### FAQ / Contact / Troubleshoot
|
|
|
|
If you have any issue you can try the following options, do no desist to ask or check our issues database, perhaps someone has asked already what you are looking for.
|
|
|
|
* [Blog](https://medium.com/verdaccio)
|
|
* [Donations](https://opencollective.com/verdaccio)
|
|
* [Roadmaps](https://github.com/verdaccio/verdaccio/projects)
|
|
* [Reporting an issue](https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md#reporting-a-bug)
|
|
* [Running discussions](https://github.com/verdaccio/verdaccio/issues?q=is%3Aissue+is%3Aopen+label%3Adiscuss)
|
|
* [Chat](http://chat.verdaccio.org/)
|
|
* [Logos](https://verdaccio.org/docs/en/logo)
|
|
* [FAQ](https://github.com/verdaccio/verdaccio/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3Aquestion%20)
|
|
* [Docker Examples](https://github.com/verdaccio/docker-examples)
|
|
|
|
### License
|
|
|
|
Verdaccio is [MIT licensed](https://github.com/verdaccio/verdaccio/blob/master/LICENSE)
|