Servercn Provider Contributing Guide

This guide explains how to contribute a Provider to Servercn. A Provider represents database connectivity and ORM setup for a runtime/framework pair (for example, MongoDB + Mongoose or PostgreSQL + Prisma).

What Is a Provider?

A Provider in Servercn is:

  • A reusable database/ORM integration layer
  • Runtime + framework scoped
  • Architecture-aware (MVC and/or Feature)
  • Production-ready with env validation and connection/client setup

Usually includes:

  • Environment config (env.ts)
  • Database client/connection config (db.ts or prisma.ts)
  • Optional logger setup
  • Optional ORM schema (for Prisma providers)

Some servercn providers:


Step-by-Step Contribution Guide

Fork & Clone the Repository

Fork the Servercn repository and clone it locally: GitHub Link

# Clone on your local machine
git clone https://github.com/<your-username>/servercn.git
 
# Navigate to project directory
cd servercn
 
# Create a new Branch
git checkout -b feat/provider-name
 
# Install dependencies
npm install
 
# Run workspaces
npm run dev:app
npm run dev:cli

Add Provider Registry

Each provider must follow this registry structure:

packages/
  registry/
    provider/
      provider-slug.json

Use this shape as a reference:

{
  "$schema": "https://servercn.vercel.app/schema/foundation.registry.json",
  "slug": "my-provider",
  "runtimes": {
    "node": {
      "frameworks": {
        "express": {
          "templates": {
            "mvc": "my-provider/mvc",
            "feature": "my-provider/feature"
          },
          "dependencies": {
            "runtime": ["@prisma/client@6"],
            "dev": ["prisma@6"]
          },
          "env": ["DATABASE_URL"]
        }
      }
    }
  }
}
  • List only truly required variables.
  • Do not include secrets with hardcoded values.

Add Templates

Create provider templates in:

packages/
  templates/
    node/
      express/
        provider/
          provider-slug/
            mvc/
            feature/

Recommended conventions:

  • Keep architecture mapping consistent (mvc vs feature).
  • Include env.ts for validation (zod).
  • Use db.ts for Drizzle/Mongoose connection helpers.
  • Use prisma.ts + schema.prisma for Prisma providers.
  • Add logger only when needed and keep it consistent with existing providers.

Test the Provider via CLI

Before submitting:

npm run dev:cli

Then test provider installation locally:

npx servercn-cli add pr provider-slug --local
  • --local uses local registry/templates for validation.

Verify:

  • No install/runtime errors
  • Files generated in correct architecture paths
  • Dependencies are installed correctly
  • Env variables expected by templates are present

Register in Web Registry

Add your provider entry to: apps/web/src/data/registry.json

{
  "slug": "provider-slug",
  "type": "provider",
  "status": "stable",
  "frameworks": ["express"],
  "title": "Provider Title",
  "description": "Provider short description",
  "docs": "/docs/providers/provider-slug",
  "meta": {
    "new": true
  }
}

This entry powers docs sidebar navigation and listing in the providers route.

Write Provider Documentation

Add docs at: apps/web/src/content/docs/express/providers/provider-slug.mdx

Commit Properly

Use conventional commits:

feat(provider): add provider-slug provider

Example:

feat(provider): add pg-prisma provider templates and docs

Submit a Pull Request

Your PR should include:

  • Registry file in packages/registry/provider/
  • Matching templates in packages/templates/node/express/provider/
  • Web registry entry in apps/web/src/data/registry.json
  • Provider docs page in apps/web/src/content/docs/express/providers/
  • Local CLI testing confirmation

License

By contributing a provider to Servercn, you agree that your contribution will be licensed under the MIT License.

Thank you for contributing to Servercn providers 🚀 Your work helps developers connect data layers faster and more reliably.