for developers
Welcome
Boilerplates
Code Linting
Github Actions
Private RegistryHow it worksAuthenticationPublishingNaming conventionWhat about our NPM packages?
Styled
🔒  Local Setup
🔒  Server Setup
🔒  Code Challenge

Private registry

How it works

Our private registry is developed with Verdaccio, a lightweight open-source private npm proxy registry.
It contains every package distributed and used internally (unless there is a need to make it public).

Authentication

To authenticate, you need to add the private registry to your local ~/.npmrc file

To do this, please follow these instructions:

  1. Go to https://registry.wild.plus
  2. Click on Login
  3. Grant permissions to the Github application (you need to be part of our Github organization)

./github-auth.png

  1. Click the Info button at the top

./info.png

  1. The overlay now shows three commands you need to run locally, one after another

./info.png

  1. Your local ~/.npmrc file should now contain these lines:
registry=https://registry.wild.plus/
//registry.wild.plus/:_authToken="{TOKEN}"
//registry.wild.plus/:always-auth true
  1. And you're all done, now you can install private or newer packages in the @madebywild/* namespace from the private registry

Publishing

Once authenticated, there are no limitations of any kind, you can publish and unpublish packages with the npm publish and npm unpublish commands. Obviously, use them responsibly.

Naming convention

Internal packages use the @madebywild/* namespace.

What about our NPM packages?

Verdaccio works as a proxy to the NPM registry, meaning that:

  • if a @madebywild/* package is published on both Verdaccio and NPM registries, Verdaccio takes precedence.
  • if a @madebywild/* package is published only on NPM, it will be normally used.