Skip to content

Sparkyyy45/openenv

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

24 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🌍 openenv

The open standard for production-ready full-stack starter kits.

Stop rebuilding auth, payments, and infrastructure from scratch. Pick a kit. Run one command. Ship.

License: MIT


🚨 The Problem

Every new project starts the exact same way. You spend days setting up authentication, configuring a database, wiring up payments, writing Docker configs, and wrestling with CI pipelines. By the time you're ready to write your actual app, you're already exhausted.

openenv fixes this.

πŸ’‘ The Solution

openenv is an open registry of production-ready starter kits powered by an ultra-fast, bulletproof CLI. It scaffolds everything you need in seconds. Every kit is verified by CI and comes pre-configured with:

  • βœ… Working authentication (NextAuth, Supabase, JWT)
  • βœ… Database with migrations (Prisma, Drizzle, SQLAlchemy)
  • βœ… Docker Compose for instant local dev environments
  • βœ… Health check endpoints (pre-configured)
  • βœ… One-command setup scripts (./setup.sh)
  • βœ… Environment variable documentation
  • βœ… Deployment-ready configurations (Dockerfiles, GitHub Actions)

⚑ Quick Start (Interactive)

Just run openenv in your terminal! The CLI is fully interactive, completely beginner-friendly, and handles all errors gracefully.

# 1. Install globally directly from GitHub
npm install -g Sparkyyy45/openenv

# 2. Run the interactive kit picker
openenv

You'll be greeted with our beautiful CLI interface:

╔═════════════════════════════════╗
β•‘  openenv  v0.1.0                β•‘
β•‘  production-ready stacks, fast  β•‘
β•šβ•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•

? Which kit would you like to initialize? (Use arrow keys)
❯ api-fastapi-postgres-redis  β€” Production API: FastAPI, PostgreSQL, Redis
  saas-nextjs-supabase-stripe β€” Full SaaS starter with auth, payments
  ...

⚑ Quick Start

If you already know what you want, you can pass arguments directly:

# See all available kits
openenv list

# Scaffold a specific kit directly
openenv init saas-nextjs-supabase-stripe

# Check your environment (Docker, Ports, Node version)
openenv doctor

# Generate deployment pipelines!
openenv deploy

πŸ“¦ Available Kits

Kit Stack Description
saas-nextjs-supabase-stripe Next.js 14 Β· Supabase Β· Stripe Β· Tailwind Full SaaS starter with auth, payments, and dashboard
api-fastapi-postgres-redis FastAPI Β· PostgreSQL Β· Redis Β· SQLAlchemy Production API with async CRUD, caching, and tests
mern-stack-auth React Β· Express.js Β· MongoDB MERN Stack with JWT Auth and Docker MongoDB
t3-app-router Next.js 14 Β· Prisma Β· tRPC T3 Stack: Next.js 14, Tailwind, Prisma, tRPC
django-react-postgres Django Β· React Β· PostgreSQL Django REST Framework backend with React frontend and Postgres
go-gin-postgres-api Go Β· Gin Β· PostgreSQL High performance Go API with Gin and PostgreSQL
vue-vite-firebase Vue 3 Β· Vite Β· Firebase Vue 3 serverless frontend with Firebase auth and database
express-prisma-sqlite Express.js Β· Prisma Β· SQLite Fastest Node.js API setup with Express, Prisma and local SQLite

Want to see more? Submit a kit β†’


πŸ”§ CLI Commands

openenv list

Browse all available kits from the registry.

openenv list                    # Show all kits
openenv list --tag saas         # Filter by tag
openenv list --json             # Raw JSON output

openenv init [kit-name]

Scaffold a kit into your project directory.

openenv init                                    # Interactive picker
openenv init saas-nextjs-supabase-stripe        # Direct scaffold
openenv init api-fastapi-postgres-redis --dir ./my-api  # Custom directory
openenv init saas-nextjs-supabase-stripe --dry-run      # Preview only

openenv doctor

Diagnose your local environment. It checks if you have Node.js, Docker, and the correct ports available. It even suggests how to fix issues!

openenv doctor          # Check environment
openenv doctor --fix    # Auto-fix safe issues (like npm install)

openenv deploy

Generate deployment configurations (Dockerfiles and GitHub Actions) for your project instantly.

openenv deploy --provider render

πŸ“ Kit Spec

Every openenv kit follows a strict specification:

kits/<kit-name>/
β”œβ”€β”€ kit.json              # Metadata + health check config
β”œβ”€β”€ .env.example          # Documented environment variables
β”œβ”€β”€ docker-compose.yml    # Local development services
β”œβ”€β”€ setup.sh              # One-command setup (idempotent)
β”œβ”€β”€ README.md             # Full documentation
└── template/             # The runnable application

This ensures every kit is consistent, verified, and production-ready.


🀝 Contributing

We'd love your help! Here's how:

Contribution Guide
🧰 Submit a new kit Kit Spec + Issue Template
πŸ› Report a bug Open an Issue
πŸ“ Improve docs Contributing Guide
⭐ Star this repo It helps more than you think!

See CONTRIBUTING.md for the full guide.


πŸ—οΈ Architecture

openenv/
β”œβ”€β”€ packages/cli/          # The `openenv` npm package
β”‚   β”œβ”€β”€ src/index.js       # CLI entry point (Commander.js)
β”‚   β”œβ”€β”€ src/commands/      # list, init, doctor
β”‚   └── src/utils/         # logger, registry helpers
β”œβ”€β”€ kits/                  # Starter kit templates
β”œβ”€β”€ docs/                  # Specification & guides
β”œβ”€β”€ registry.json          # Master kit registry
└── .github/workflows/     # CI: verify-kits + publish-cli

πŸ“„ License

MIT β€” see LICENSE.

πŸš€ What's Next? (Roadmap)

We are constantly improving openenv. Here is what we plan to implement next:

  1. openenv add <feature>: Instead of scaffolding a full kit, inject features (like Stripe, Tailwind, or Redis) directly into your existing projects.
  2. Custom GitHub Repositories: Run openenv init username/repo to scaffold from any public GitHub repository, utilizing openenv's robust setup checks.
  3. Cloud Environment Sync (openenv env): Securely pull .env secrets from Vercel, Render, or a centralized vault so you never have to copy-paste API keys again.
  4. Auto-provisioning (openenv deploy): Native integrations with Vercel and Railway APIs to automatically provision live databases and hostings straight from the CLI.

Built with ❀️ by the openenv community

Website Β· GitHub