When building backend services, how often do you find yourself rewriting the same API logic? Maybe you’ve tried saving snippets in a GitHub repo, a GitHub Gist, or you have a personal "starter template" that you copy-paste into new projects.
But let's be real—most of the time, we forget those exist until it's too late. Then, you're manually resolving imports, restructuring folders, and dealing with dependency mismatches.
Wouldn’t it be better if you could reuse API logic as easily as installing an NPM package?
That’s exactly what Vratix Private API Modules do.
What Are Private API Modules?
Think of it as your own private NPM registry - but instead of installing black-box libraries, you get full ownership of the source code.
With Private API Modules, you can:
- Write custom API logic once and reuse it across multiple backend services.
- Publish modules privately for personal use or within a team.
- Seamlessly install modules into new Node.js projects using the Vratix CLI.
- Modify and extend modules without being locked into a dependency.
This builds on the success of our Community API Modules, but now, you get the same convenience with your own private code.
How It Works
- Write your API module - Either use our CLI to generate one or start from a GitHub template.
- Publish it to your private registry - Store your module securely for future projects.
- Install it whenever you need it – No more searching through old repos or manually copying code.
Setting Up Private API Modules
Step 1: Create a Vratix Account
Sign up for a free Vratix account, and we’ll automatically create your Private Registry.
Step 2: Authenticate Your CLI
Before publishing or installing private modules, authenticate your CLI session:
npx vratix login
This will open a browser where you can log in. Sessions last 1 hour before requiring re-authentication.
Step 3: Create a New Private API Module
Option 1: Use the GitHub Template
We provide a GitHub template for quick setup. Fork it, modify your API logic, and link it to your Vratix account.
Option 2: Use the CLI
Run the following to generate a new API module locally:
npx vratix module new
This will scaffold the module structure, including the required manifest.json file.
Step 4: Publish Your Module
Using GitHub
Connect a GitHub repository to your Vratix Dashboard, and we’ll automatically pull updates from your main branch.
Using the CLI
If your module is ready, publish it with:
npx vratix module publish --private
This will upload the module to your private registry, making it available for installation.
Step 5: Install a Private Module
When starting a new Node.js project, install your private module with:
npx vratix add
This will prompt you to select from Community Modules or your Private Registry.
Why This Matters
Developers have long relied on NPM for package management - but sometimes, you don’t want to install a third-party library. You just need your own code in a modular, reusable way.
With Vratix Private Modules, you get the best of both worlds:
- The flexibility of owning the full source code
- The ease of installing and managing API logic like an NPM package
We’re excited to see what you build with it. Try it out and let us know what you think!
Top comments (0)