Verdaccio UI is a theme plugin build in React, Typescript and Emotion. It uses Jest and Testing Library for Unit testing.
If you are willing to ship an improvement for Verdaccio 5.x, here is the repo where you must contribute, but remember, if you are willing your feature persist in next major releases, you also need to PR here since this repo is intended to be archived after Verdaccio 5 is being deprecated in the future.
We use >=yarn, keep in mind that we use lockfiles and use at least Node v14 to be able to build the project.
Install dependencies
yarn
For development run the following command, it will execute webpack and verdaccio to
yarn devThe 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.
Don't forget run the following commands before commit and push your code, it will save you time.
yarn lint && yarn testRemember we follow the the Conventional Commits specification.
🤓 Feel free to participate in code reviews, let us know if you want to participate in this plugin.
Additionally, we recommend run E2E testing before push and verify your changes do not break anything. These command will run in our CI anyway.
yarn build && yarn test:e2e
yarn buildwill build with webpack the production files.
Thanks to the following companies to help us to achieve our goals providing free open source licenses.
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
Thank you to all our backers! 🙏 [Become a backer]
This project exists thanks to all the people who contribute.
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.
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.
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": {
...,
"czech": "Tcheco"
}
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/
Verdaccio is MIT licensed
 Juan Picado 📖 💻 🚇 📋 📝 🚧 |
 Sergio Herrera 🚇 🚧 |
 Daniel Ruf 🛡️ 🚇 🚧 |
 Priscila Oliveira 🎨 💻 🚧 |
 Jiří Michel 💻 🚧 |
 jason 🌍 💻 |
 Ayush Sharma 🚧 💻 |