openship 0.1.0

package/.env.example

@@ -0,0 +1,22 @@
+# See docker-compose.yml for full reference.
+# Copy this file to .env and customize.
+
+NODE_ENV=development
+
+# ─── Database ────────────────────────────────
+DATABASE_URL=postgresql://openship:openship@localhost:5432/openship
+
+# ─── Redis ───────────────────────────────────
+REDIS_URL=redis://localhost:6379
+
+# ─── Auth ────────────────────────────────────
+JWT_SECRET=change-me-in-production
+
+# ─── Mode ────────────────────────────────────
+# false = self-hosted (no billing)
+# true  = cloud (billing, metering, multi-tenant)
+CLOUD_MODE=false
+
+# ─── Stripe (required only when CLOUD_MODE=true) ──
+# STRIPE_SECRET_KEY=sk_test_...
+# STRIPE_WEBHOOK_SECRET=whsec_...

package/.nvmrc

@@ -0,0 +1 @@
+20

package/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "semi": true,
+  "singleQuote": false,
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "printWidth": 100
+}

package/CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# Contributing to Openship
+
+Thank you for your interest in contributing! This guide will help you get started.
+
+## Development Setup
+
+1. **Fork & clone** the repository
+2. **Install dependencies**: `pnpm install`
+3. **Set up env**: `cp .env.example .env`
+4. **Generate DB client**: `pnpm db:generate`
+5. **Start dev**: `pnpm dev`
+
+## Project Structure
+
+- `apps/*` — Deployable applications (web, dashboard, api, cli)
+- `packages/*` — Shared libraries consumed by apps
+- `tooling/*` — Build and lint configurations
+
+## Conventions
+
+- **Commits**: Follow [Conventional Commits](https://www.conventionalcommits.org/) (`feat:`, `fix:`, `docs:`, etc.)
+- **Branches**: `feat/`, `fix/`, `docs/`, `chore/`
+- **Code style**: Prettier is configured — run `pnpm format` before committing
+- **Types**: TypeScript strict mode is enabled everywhere
+
+## API Module Pattern
+
+Each API module follows this structure:
+
+```
+modules/<name>/
+  ├── <name>.routes.ts      # Route definitions
+  ├── <name>.controller.ts   # Request handlers
+  ├── <name>.service.ts      # Business logic
+  └── <name>.schema.ts       # Zod validation schemas
+```
+
+## Need Help?
+
+Open an issue or start a discussion — we're happy to help!

package/README.md

@@ -0,0 +1,164 @@
+<div align="center">
+  <h1>🚀 Openship</h1>
+  <p><strong>The open-source, self-hostable deployment platform.</strong></p>
+  <p>Deploy anywhere — from your own server to our managed cloud.</p>
+
+  <br />
+
+  <a href="#quick-start">Quick Start</a> ·
+  <a href="#architecture">Architecture</a> ·
+  <a href="#self-hosting">Self-Hosting</a> ·
+  <a href="#cloud">Cloud</a> ·
+  <a href="#contributing">Contributing</a>
+</div>
+
+---
+
+## Quick Start
+
+### Prerequisites
+
+- [Node.js](https://nodejs.org/) >= 20
+- [pnpm](https://pnpm.io/) >= 9
+- [Docker](https://www.docker.com/) (for self-hosting or local development)
+
+### Development
+
+```bash
+# Clone the repo
+git clone https://github.com/openship/openship.git
+cd openship
+
+# Install dependencies
+pnpm install
+
+# Set up environment
+cp .env.example .env
+
+# Generate Prisma client
+pnpm db:generate
+
+# Push schema to local SQLite
+pnpm db:push
+
+# Start all apps in dev mode
+pnpm dev
+```
+
+This will start:
+
+| App         | URL                     |
+| ----------- | ----------------------- |
+| Web         | http://localhost:3000    |
+| Dashboard   | http://localhost:3001    |
+| API         | http://localhost:4000    |
+
+### Self-Hosting with Docker
+
+```bash
+cp .env.example .env
+docker compose up -d
+```
+
+That's it. Openship will be running at `http://localhost:3001`.
+
+---
+
+## Architecture
+
+```
+openship/
+├── apps/
+│   ├── web/          # Next.js — Marketing site, landing page, docs, pricing
+│   ├── dashboard/    # Next.js — Authenticated deployment dashboard (Vercel-style)
+│   ├── api/          # Hono — Core API engine (auth, deployments, billing, webhooks)
+│   └── cli/          # TypeScript CLI — `openship deploy` from your terminal
+│
+├── packages/
+│   ├── adapters/     # Deployment adapters (DockerAdapter, OblienAdapter)
+│   ├── db/           # Prisma schema + client (SQLite local, Postgres cloud)
+│   ├── core/         # Shared types, constants, utilities, error classes
+│   └── ui/           # Shared React component library (Tailwind + shadcn style)
+│
+├── tooling/
+│   └── tsconfig/     # Shared TypeScript configurations
+│
+├── docker-compose.yml
+├── turbo.json
+└── pnpm-workspace.yaml
+```
+
+### API Modules
+
+The API is organized into clean, independent modules:
+
+| Module         | Path                          | Purpose                                  |
+| -------------- | ----------------------------- | ---------------------------------------- |
+| **Auth**       | `modules/auth/`               | Registration, login, JWT, sessions       |
+| **Projects**   | `modules/projects/`           | CRUD for deployment projects             |
+| **Deployments**| `modules/deployments/`        | Build, deploy, rollback, logs            |
+| **Domains**    | `modules/domains/`            | Custom domains, DNS verification, SSL    |
+| **Billing**    | `modules/billing/`            | Plans, subscriptions, usage (cloud only) |
+| **Webhooks**   | `modules/webhooks/`           | GitHub/GitLab/Bitbucket push triggers    |
+| **Health**     | `modules/health/`             | Health check endpoint for load balancers |
+
+### Adapter Pattern
+
+The **adapter pattern** is what makes Openship platform-agnostic:
+
+- **`DockerAdapter`** — Self-hosted. Builds and runs containers on the host machine.
+- **`OblienAdapter`** — Cloud. Communicates with the Oblien infrastructure API.
+
+The `CLOUD_MODE` environment variable controls which adapter is active. For self-hosted installs, billing is completely disabled.
+
+---
+
+## Self-Hosting
+
+Openship is designed to be self-hosted with a single `docker compose up`. The Docker adapter handles all builds and deployments locally on your machine.
+
+**Requirements:** Docker Engine, 2GB RAM minimum.
+
+---
+
+## Cloud
+
+The hosted version at [openship.cloud](https://openship.cloud) adds:
+
+- Managed infrastructure via the Oblien adapter
+- Subscription billing (Stripe)
+- Usage metering (build minutes, bandwidth)
+- Team management and SSO
+
+---
+
+## Tech Stack
+
+| Layer      | Technology                        |
+| ---------- | --------------------------------- |
+| Frontend   | Next.js 14, React 18, Tailwind    |
+| API        | Hono (edge-compatible)             |
+| Database   | Prisma (SQLite / PostgreSQL)       |
+| Queue      | BullMQ + Redis                     |
+| CLI        | Commander.js, TypeScript           |
+| Monorepo   | Turborepo + pnpm workspaces       |
+| Containers | Docker                             |
+| Billing    | Stripe                             |
+
+---
+
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feat/amazing-feature`)
+3. Commit your changes (`git commit -m 'feat: add amazing feature'`)
+4. Push to the branch (`git push origin feat/amazing-feature`)
+5. Open a Pull Request
+
+---
+
+## License
+
+[MIT](LICENSE) — Free to use, self-host, and modify. Cloud/SaaS usage requires the AGPL license terms.

package/apps/api/.env.example

@@ -0,0 +1,30 @@
+# Openship API — Environment Variables
+# Copy this file to .env and fill in the values.
+
+NODE_ENV=development
+PORT=4000
+
+# ---------- Mode ----------
+# Set to "true" to enable cloud billing, metering, multi-tenant features.
+# Default: false (self-hosted single-tenant mode).
+CLOUD_MODE=false
+
+# ---------- Database ----------
+DATABASE_URL=file:./dev.db
+
+# ---------- Auth ----------
+JWT_SECRET=change-me-in-production
+JWT_EXPIRES_IN=15m
+JWT_REFRESH_EXPIRES_IN=7d
+
+# ---------- Redis ----------
+REDIS_URL=redis://localhost:6379
+
+# ---------- Stripe (Cloud mode only) ----------
+# STRIPE_SECRET_KEY=sk_test_...
+# STRIPE_WEBHOOK_SECRET=whsec_...
+
+# ---------- GitHub App (for Git push webhooks) ----------
+# GITHUB_APP_ID=
+# GITHUB_PRIVATE_KEY=
+# GITHUB_WEBHOOK_SECRET=

package/apps/api/Dockerfile

@@ -0,0 +1,24 @@
+# ─── Build stage ────────────────────────────────────────
+FROM node:20-alpine AS builder
+RUN corepack enable && corepack prepare pnpm@9.0.0 --activate
+WORKDIR /app
+
+COPY pnpm-workspace.yaml pnpm-lock.yaml* package.json ./
+COPY tooling/ ./tooling/
+COPY packages/ ./packages/
+COPY apps/api/ ./apps/api/
+
+RUN pnpm install --frozen-lockfile
+RUN pnpm run build --filter=openship-api...
+
+# ─── Production stage ──────────────────────────────────
+FROM node:20-alpine AS runner
+WORKDIR /app
+
+COPY --from=builder /app/apps/api/dist ./dist
+COPY --from=builder /app/apps/api/package.json ./
+COPY --from=builder /app/node_modules ./node_modules
+
+ENV NODE_ENV=production
+EXPOSE 4000
+CMD ["node", "dist/index.js"]

package/apps/api/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "openship-api",
+  "version": "0.1.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "tsx watch src/index.ts",
+    "build": "tsup src/index.ts --format esm --dts",
+    "start": "node dist/index.js",
+    "lint": "tsc --noEmit",
+    "test": "vitest run",
+    "clean": "rm -rf dist .turbo node_modules"
+  },
+  "dependencies": {
+    "openship-core": "workspace:*",
+    "openship-db": "workspace:*",
+    "openship-adapters": "workspace:*",
+    "@hono/node-server": "^1.11.0",
+    "hono": "^4.4.0",
+    "zod": "^3.23.0",
+    "jsonwebtoken": "^9.0.0",
+    "bcryptjs": "^2.4.3",
+    "stripe": "^15.0.0",
+    "bullmq": "^5.7.0",
+    "ioredis": "^5.4.0",
+    "pino": "^9.1.0"
+  },
+  "devDependencies": {
+    "openship-tsconfig": "workspace:*",
+    "@types/jsonwebtoken": "^9.0.0",
+    "@types/bcryptjs": "^2.4.0",
+    "tsx": "^4.11.0",
+    "tsup": "^8.1.0",
+    "vitest": "^1.6.0",
+    "typescript": "^5.4.0"
+  }
+}

package/apps/api/src/app.ts

@@ -0,0 +1,26 @@
+import { Hono } from "hono";
+import { cors } from "hono/cors";
+import { logger } from "hono/logger";
+
+import { authRoutes } from "./modules/auth/auth.routes";
+import { projectRoutes } from "./modules/projects/project.routes";
+import { deploymentRoutes } from "./modules/deployments/deployment.routes";
+import { domainRoutes } from "./modules/domains/domain.routes";
+import { billingRoutes } from "./modules/billing/billing.routes";
+import { webhookRoutes } from "./modules/webhooks/webhook.routes";
+import { healthRoutes } from "./modules/health/health.routes";
+
+export const app = new Hono();
+
+/* ---------- Global middleware ---------- */
+app.use("*", logger());
+app.use("*", cors());
+
+/* ---------- Module routes ---------- */
+app.route("/api/health", healthRoutes);
+app.route("/api/auth", authRoutes);
+app.route("/api/projects", projectRoutes);
+app.route("/api/deployments", deploymentRoutes);
+app.route("/api/domains", domainRoutes);
+app.route("/api/billing", billingRoutes);
+app.route("/api/webhooks", webhookRoutes);

package/apps/api/src/config/env.ts

@@ -0,0 +1,39 @@
+import { z } from "zod";
+
+/**
+ * API configuration — loaded from environment variables.
+ *
+ * CLOUD_MODE=true enables billing, metering, and multi-tenant features.
+ * CLOUD_MODE=false (default) runs as a self-hosted single-tenant instance.
+ */
+const envSchema = z.object({
+  NODE_ENV: z.enum(["development", "production", "test"]).default("development"),
+  PORT: z.coerce.number().default(4000),
+
+  /* ---------- Mode ---------- */
+  CLOUD_MODE: z.coerce.boolean().default(false),
+
+  /* ---------- Database ---------- */
+  DATABASE_URL: z.string().default("file:./dev.db"),
+
+  /* ---------- Auth ---------- */
+  JWT_SECRET: z.string().default("change-me-in-production"),
+  JWT_EXPIRES_IN: z.string().default("15m"),
+  JWT_REFRESH_EXPIRES_IN: z.string().default("7d"),
+
+  /* ---------- Redis ---------- */
+  REDIS_URL: z.string().default("redis://localhost:6379"),
+
+  /* ---------- Stripe (Cloud only) ---------- */
+  STRIPE_SECRET_KEY: z.string().optional(),
+  STRIPE_WEBHOOK_SECRET: z.string().optional(),
+
+  /* ---------- Git Providers ---------- */
+  GITHUB_APP_ID: z.string().optional(),
+  GITHUB_PRIVATE_KEY: z.string().optional(),
+  GITHUB_WEBHOOK_SECRET: z.string().optional(),
+});
+
+export type Env = z.infer<typeof envSchema>;
+
+export const env = envSchema.parse(process.env);

package/apps/api/src/config/index.ts

@@ -0,0 +1 @@
+export { env } from "./env";

package/apps/api/src/index.ts

@@ -0,0 +1,8 @@
+import { serve } from "@hono/node-server";
+import { app } from "./app";
+
+const port = Number(process.env.PORT) || 4000;
+
+serve({ fetch: app.fetch, port }, (info) => {
+  console.log(`🚀 Openship API running on http://localhost:${info.port}`);
+});

package/apps/api/src/middleware/auth.ts

@@ -0,0 +1,24 @@
+import type { Context, Next } from "hono";
+
+/**
+ * JWT authentication middleware.
+ * Extracts and verifies the Bearer token from the Authorization header.
+ */
+export async function authMiddleware(c: Context, next: Next) {
+  const header = c.req.header("Authorization");
+
+  if (!header?.startsWith("Bearer ")) {
+    return c.json({ error: "Unauthorized" }, 401);
+  }
+
+  const token = header.slice(7);
+
+  try {
+    // TODO: Verify JWT, attach user to context
+    // const payload = verifyToken(token);
+    // c.set("user", payload);
+    await next();
+  } catch {
+    return c.json({ error: "Invalid token" }, 401);
+  }
+}

package/apps/api/src/middleware/error-handler.ts

@@ -0,0 +1,21 @@
+import type { Context, Next } from "hono";
+import { ZodError } from "zod";
+
+/**
+ * Global error handler middleware.
+ */
+export async function errorHandler(c: Context, next: Next) {
+  try {
+    await next();
+  } catch (err) {
+    if (err instanceof ZodError) {
+      return c.json(
+        { error: "Validation error", details: err.flatten().fieldErrors },
+        400,
+      );
+    }
+
+    console.error("[ERROR]", err);
+    return c.json({ error: "Internal server error" }, 500);
+  }
+}

package/apps/api/src/middleware/index.ts

@@ -0,0 +1,3 @@
+export { authMiddleware } from "./auth";
+export { rateLimiter } from "./rate-limiter";
+export { errorHandler } from "./error-handler";

package/apps/api/src/middleware/rate-limiter.ts

@@ -0,0 +1,26 @@
+import type { Context, Next } from "hono";
+
+/**
+ * Rate-limiting middleware.
+ * Uses a simple in-memory store (swap for Redis in production).
+ */
+const requestCounts = new Map<string, { count: number; resetAt: number }>();
+
+export async function rateLimiter(c: Context, next: Next) {
+  const ip = c.req.header("x-forwarded-for") || "unknown";
+  const now = Date.now();
+  const window = 60_000; // 1 minute
+  const maxRequests = 100;
+
+  const entry = requestCounts.get(ip);
+
+  if (!entry || now > entry.resetAt) {
+    requestCounts.set(ip, { count: 1, resetAt: now + window });
+  } else if (entry.count >= maxRequests) {
+    return c.json({ error: "Too many requests" }, 429);
+  } else {
+    entry.count++;
+  }
+
+  await next();
+}

package/apps/api/src/modules/auth/auth.controller.ts

@@ -0,0 +1,26 @@
+import type { Context } from "hono";
+
+export async function register(c: Context) {
+  // TODO: Implement registration with auth.service
+  return c.json({ message: "register" }, 201);
+}
+
+export async function login(c: Context) {
+  // TODO: Implement login
+  return c.json({ message: "login" });
+}
+
+export async function logout(c: Context) {
+  // TODO: Implement logout
+  return c.json({ message: "logout" });
+}
+
+export async function refresh(c: Context) {
+  // TODO: Implement token refresh
+  return c.json({ message: "refresh" });
+}
+
+export async function me(c: Context) {
+  // TODO: Return current user from JWT
+  return c.json({ message: "me" });
+}

package/apps/api/src/modules/auth/auth.routes.ts

@@ -0,0 +1,10 @@
+import { Hono } from "hono";
+import * as authController from "./auth.controller";
+
+export const authRoutes = new Hono();
+
+authRoutes.post("/register", authController.register);
+authRoutes.post("/login", authController.login);
+authRoutes.post("/logout", authController.logout);
+authRoutes.post("/refresh", authController.refresh);
+authRoutes.get("/me", authController.me);

package/apps/api/src/modules/auth/auth.schema.ts

@@ -0,0 +1,12 @@
+import { z } from "zod";
+
+export const registerSchema = z.object({
+  email: z.string().email(),
+  password: z.string().min(8),
+  name: z.string().optional(),
+});
+
+export const loginSchema = z.object({
+  email: z.string().email(),
+  password: z.string(),
+});

package/apps/api/src/modules/auth/auth.service.ts

@@ -0,0 +1,23 @@
+/**
+ * Auth service — handles password hashing, JWT signing, user creation.
+ */
+
+export async function createUser(data: {
+  email: string;
+  password: string;
+  name?: string;
+}) {
+  // TODO: Hash password, insert into DB, return user
+}
+
+export async function verifyCredentials(email: string, password: string) {
+  // TODO: Fetch user, compare password hash
+}
+
+export async function generateTokens(userId: string) {
+  // TODO: Sign access + refresh JWTs
+}
+
+export async function refreshAccessToken(refreshToken: string) {
+  // TODO: Verify refresh token, return new access token
+}

package/apps/api/src/modules/billing/billing.controller.ts

@@ -0,0 +1,60 @@
+import type { Context } from "hono";
+
+/* ---------- Plans ---------- */
+export async function listPlans(c: Context) {
+  // TODO: Return available pricing plans (free, pro, team, enterprise)
+  return c.json({
+    data: [
+      { id: "free", name: "Free", price: 0, features: ["Self-hosted", "Community support"] },
+      { id: "pro", name: "Pro", price: 20, features: ["Cloud hosting", "Custom domains", "Priority support"] },
+      { id: "team", name: "Team", price: 50, features: ["All Pro features", "Team management", "SSO"] },
+    ],
+  });
+}
+
+/* ---------- Subscriptions ---------- */
+export async function getSubscription(c: Context) {
+  return c.json({ data: null });
+}
+
+export async function createSubscription(c: Context) {
+  // TODO: Create Stripe checkout session
+  return c.json({ message: "subscription created" }, 201);
+}
+
+export async function updateSubscription(c: Context) {
+  // TODO: Upgrade/downgrade plan
+  return c.json({ message: "subscription updated" });
+}
+
+export async function cancelSubscription(c: Context) {
+  // TODO: Cancel at period end
+  return c.json({ message: "subscription cancelled" });
+}
+
+/* ---------- Usage ---------- */
+export async function getUsage(c: Context) {
+  // TODO: Return current billing period usage (build minutes, bandwidth, etc.)
+  return c.json({ data: { buildMinutes: 0, bandwidth: 0 } });
+}
+
+/* ---------- Payment Methods ---------- */
+export async function listPaymentMethods(c: Context) {
+  return c.json({ data: [] });
+}
+
+export async function addPaymentMethod(c: Context) {
+  // TODO: Create Stripe setup intent
+  return c.json({ message: "payment method added" }, 201);
+}
+
+/* ---------- Invoices ---------- */
+export async function listInvoices(c: Context) {
+  return c.json({ data: [] });
+}
+
+/* ---------- Stripe Webhook ---------- */
+export async function stripeWebhook(c: Context) {
+  // TODO: Verify Stripe signature, handle events
+  return c.json({ received: true });
+}

package/apps/api/src/modules/billing/billing.routes.ts

@@ -0,0 +1,26 @@
+import { Hono } from "hono";
+import * as billingController from "./billing.controller";
+
+export const billingRoutes = new Hono();
+
+/* ---------- Plans & Pricing ---------- */
+billingRoutes.get("/plans", billingController.listPlans);
+
+/* ---------- Subscriptions ---------- */
+billingRoutes.get("/subscription", billingController.getSubscription);
+billingRoutes.post("/subscription", billingController.createSubscription);
+billingRoutes.patch("/subscription", billingController.updateSubscription);
+billingRoutes.delete("/subscription", billingController.cancelSubscription);
+
+/* ---------- Usage ---------- */
+billingRoutes.get("/usage", billingController.getUsage);
+
+/* ---------- Payment Methods ---------- */
+billingRoutes.get("/payment-methods", billingController.listPaymentMethods);
+billingRoutes.post("/payment-methods", billingController.addPaymentMethod);
+
+/* ---------- Invoices ---------- */
+billingRoutes.get("/invoices", billingController.listInvoices);
+
+/* ---------- Stripe Webhook (no auth) ---------- */
+billingRoutes.post("/webhook/stripe", billingController.stripeWebhook);

package/apps/api/src/modules/billing/billing.schema.ts

@@ -0,0 +1,9 @@
+import { z } from "zod";
+
+export const createSubscriptionSchema = z.object({
+  planId: z.enum(["free", "pro", "team"]),
+});
+
+export const updateSubscriptionSchema = z.object({
+  planId: z.enum(["free", "pro", "team"]),
+});