2019-04-05 02:28:55 +07:00
# Version 4 UI Theme
2019-04-26 00:49:19 +07:00
[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.
2019-06-20 19:37:28 +07:00
[](https://www.npmjs.com/package/@verdaccio/ui-theme)
2019-04-05 02:28:55 +07:00
[](https://verdaccio.org/docs/en/docker.html)
[](https://opencollective.com/verdaccio)
[](https://stackshare.io/verdaccio)
[](http://chat.verdaccio.org/)
2019-06-20 19:37:28 +07:00
[](https://www.npmjs.com/package/@verdaccio/ui-theme)
2020-01-14 09:47:14 +07:00
[](./LICENSE)
2019-04-05 02:28:55 +07:00
[](https://crowdin.com/project/verdaccio)
2019-06-20 19:37:28 +07:00
[](https://codecov.io/gh/verdaccio/ui)
2019-04-05 02:28:55 +07:00
[](https://twitter.com/verdaccio_npm)
[](https://github.com/verdaccio/verdaccio/stargazers)
2019-04-26 00:49:19 +07:00
## Contributing
2019-12-30 16:04:42 +07:00
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.
2019-04-26 00:49:19 +07:00
2019-06-20 19:37:28 +07:00
For development run the following command, it will execute `webpack` and `verdaccio` to
2019-04-26 00:49:19 +07:00
2019-09-29 23:33:04 +07:00
```bash
2019-04-26 00:49:19 +07:00
yarn dev
```
The configuration file is located on `tools/_config.yaml` .
2019-04-26 00:53:01 +07:00
Run linting tooling and test to check your code is clean before commit.
2019-04-26 00:49:19 +07:00
2019-10-16 12:44:26 +07:00
> ⚠️ 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.
2019-09-29 23:33:04 +07:00
```bash
2019-04-26 00:49:19 +07:00
yarn lint & & yarn test
```
2019-10-16 12:49:21 +07:00
#### Commits
2019-04-26 00:49:19 +07:00
Remember we follow the [the Conventional Commits specification ](https://www.conventionalcommits.org/en/v1.0.0-beta.4/ ).
2019-04-05 02:28:55 +07:00
2019-04-26 00:49:19 +07:00
🤓 Feel free to participate in code reviews, let us know if you want to participate in this plugin.
2019-04-05 02:28:55 +07:00
2019-10-16 12:44:26 +07:00
### 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.
2019-04-05 02:28:55 +07:00
## 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
2019-10-02 22:01:20 +07:00
This project exists thanks to all the people who contribute.
2019-04-05 02:28:55 +07:00
[](../../graphs/contributors)
2019-04-26 00:49:19 +07:00
### FAQ / Contact / Troubleshoot
2019-04-05 02:28:55 +07:00
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 )
2020-03-16 14:24:36 +07:00
* [Roadmaps ](https://github.com/verdaccio/ui/projects )
2019-04-05 02:28:55 +07:00
* [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 )
2020-03-16 14:26:11 +07:00
### Translations
2020-03-16 14:24:36 +07:00
2020-03-16 14:26:48 +07:00
Translations are handled locally. I18n files can be found in the folder ```i18n/translations/*``` of this repository. We would love to provide translations from other languages, embracing all our users, but unfortunately we cannot do this without your help. Would you like to help us? Please feel **super welcome** to add a locale by opening a pull request.
2020-03-16 14:24:36 +07:00
2020-05-03 13:21:59 +07:00
Your PR should contain:
1 - A json file in the folder ```i18n/translations/*``` with the translations. The file must be named according to the new added language
2 - The files ```i18n/config.ts``` and ```LanguageSwitch.tsx``` updated with the new language. Please see the current structure
3 - The other translations containing the new language in the language of the file. Example:
New language: ```cs_CZ ```
The file ```pt-BR ``` should contain:
```
"lng": {
...,
2020-05-03 20:28:38 +07:00
"czech": "Tcheco"
2020-05-03 13:21:59 +07:00
}
```
4 - A SVG flag of the new translated language in the the folder ```src/components/Icon/img/*```. You maybe want to compress the svg file using https://jakearchibald.github.io/svgomg/
2019-04-05 02:28:55 +07:00
### License
2019-04-09 05:05:45 +07:00
Verdaccio is [MIT licensed ](https://github.com/verdaccio/verdaccio/blob/master/LICENSE )
