gosetup 0.1.0

package/README.md

@@ -0,0 +1,15 @@
+# react
+
+To install dependencies:
+
+```bash
+bun install
+```
+
+To run:
+
+```bash
+bun dev
+```
+
+This project was created using `bun create tui`. [create-tui](https://git.new/create-tui) is the easiest way to get started with OpenTUI.

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "gosetup",
+  "module": "src/index.tsx",
+  "version": "0.1.0",
+  "description": "TUI for scaffolding Go backend projects",
+  "author": "divin3circle",
+  "license": "MIT",
+  "homepage": "https://github.com/divin3circle/gosetup",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/divin3circle/gosetup.git"
+  },
+  "bin": {
+    "gosetup": "./bin/gosetup"
+  },
+  "type": "module",
+  "scripts": {
+    "dev": "bun run --watch src/index.tsx",
+    "build": "bun build src/index.tsx --compile --outfile ./bin/gosetup && chmod +x ./bin/gosetup",
+    "prepublishOnly": "bun run build"
+  },
+  "files": [
+    "bin",
+    "src",
+    "package.json",
+    "README.md"
+  ],
+  "devDependencies": {
+    "@types/bun": "latest"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "@opentui/core": "^0.1.69",
+    "@opentui/react": "^0.1.69",
+    "react": "^19.2.3"
+  }
+}

package/src/index.tsx

@@ -0,0 +1,189 @@
+#!/usr/bin/env bun
+
+import { createCliRenderer, RGBA, TextAttributes } from "@opentui/core";
+import { createRoot } from "@opentui/react";
+import { useState } from "react";
+import { useKeyboard } from "@opentui/react";
+import { $ } from "bun";
+import { createDirectoryStructure, Mode } from "./utils/utils";
+import { RootDirectory } from "./utils/data";
+
+enum Screen {
+  Welcome,
+  Username,
+  Form,
+  Success,
+}
+
+function App() {
+  const [screen, setScreen] = useState(Screen.Welcome);
+  const [projectName, setProjectName] = useState("");
+  const [githubUsername, setGithubUsername] = useState("");
+  const [status, setStatus] = useState("");
+  const [loading, setLoading] = useState(false);
+
+  useKeyboard((key) => {
+    if (screen === Screen.Welcome && key.name === "return") {
+      setScreen(Screen.Username);
+    }
+  });
+
+  useKeyboard((key) => {
+    if (key.name === "escape") {
+      switch (screen) {
+        case Screen.Username:
+          setScreen(Screen.Welcome);
+          break;
+        case Screen.Form:
+          setScreen(Screen.Username);
+          break;
+      }
+    }
+  });
+
+  const handleSubmit = async (value: string) => {
+    if (!value.trim()) {
+      setStatus("Project name is required.");
+      return;
+    }
+    if (!githubUsername.trim()) {
+      setStatus("GitHub username is required.");
+      return;
+    }
+
+    setStatus("Creating project...");
+
+    try {
+      setLoading(true);
+      const name = value.trim();
+
+      const isCurrentDir = name === ".";
+
+      let targetPath: string;
+      let moduleName: string;
+
+      if (isCurrentDir) {
+        targetPath = ".";
+
+        const cwd = process.cwd();
+        moduleName = cwd.split("/").pop() || "app";
+      } else {
+        targetPath = name;
+        moduleName = name;
+        await $`mkdir -p ${targetPath}`;
+      }
+
+      await $`cd ${targetPath} && go mod init github.com/${githubUsername}/${moduleName}`;
+
+      await createDirectoryStructure(RootDirectory, targetPath);
+
+      await $`cd ${targetPath} && go mod tidy`;
+
+      setLoading(false);
+
+      if (isCurrentDir) {
+        setStatus(
+          `Project "${moduleName}" created successfully in current directory`
+        );
+      } else {
+        setStatus(`Project "${name}" created successfully in ./${name}`);
+      }
+
+      setScreen(Screen.Success);
+    } catch (error: any) {
+      setLoading(false);
+      setStatus(`Error: ${error.message}`);
+    }
+  };
+
+  return (
+    <box
+      flexGrow={1}
+      alignItems="center"
+      justifyContent="center"
+      backgroundColor={RGBA.fromHex(Mode.DARK)}
+    >
+      {screen === Screen.Welcome && (
+        <box flexDirection="column" alignItems="center">
+          <ascii-font
+            font="tiny"
+            text="Go Setup"
+            color={RGBA.fromHex(Mode.LIGHT)}
+          />
+          <text
+            attributes={TextAttributes.DIM | TextAttributes.BOLD}
+            marginTop={1}
+          >
+            Welcome to Go Backend Setup.
+          </text>
+          <text attributes={TextAttributes.BOLD} marginTop={2} fg="#ff6e58">
+            Press Enter to start
+          </text>
+        </box>
+      )}
+
+      {screen === Screen.Username && (
+        <box flexDirection="column" alignItems="center" width={50}>
+          <text
+            attributes={TextAttributes.DIM | TextAttributes.BOLD}
+            marginBottom={1}
+          >
+            Enter GitHub Username:
+          </text>
+          <input
+            value={githubUsername}
+            onChange={setGithubUsername}
+            onSubmit={() => setScreen(Screen.Form)}
+            placeholder="your-github-username"
+            focused
+            width="100%"
+            backgroundColor={RGBA.fromHex("#020202")}
+          />
+          <text attributes={TextAttributes.DIM} marginTop={4}>
+            [Esc to go back]
+          </text>
+        </box>
+      )}
+
+      {screen === Screen.Form && (
+        <box flexDirection="column" alignItems="center" width={50}>
+          <text attributes={TextAttributes.DIM} marginBottom={1}>
+            Enter Project Name:
+          </text>
+          <input
+            value={projectName}
+            onChange={setProjectName}
+            onSubmit={handleSubmit}
+            placeholder="my-go-app"
+            focused
+            width="100%"
+            backgroundColor={RGBA.fromHex("#020202")}
+          />
+          <text attributes={TextAttributes.DIM} marginTop={4}>
+            [Esc to go back]
+          </text>
+        </box>
+      )}
+
+      {screen === Screen.Success && (
+        <box flexDirection="column" alignItems="center">
+          <ascii-font text="Success!" font="tiny" />
+          <text marginTop={6} fg={RGBA.fromHex("#95f764")}>
+            {status}
+          </text>
+          <text marginTop={2}>Press Ctrl+C to exit.</text>
+        </box>
+      )}
+    </box>
+  );
+}
+
+async function main() {
+  const renderer = await createCliRenderer({
+    exitOnCtrlC: true,
+  });
+  createRoot(renderer).render(<App />);
+  renderer.start();
+}
+
+main().catch(console.error);

package/src/utils/data.ts

@@ -0,0 +1,289 @@
+import type { IDirectory, IFile } from "./types";
+
+const envLocalFile: IFile = {
+  name: ".env.local",
+  content: `# Environment variables
+    PORT=
+    POSTGRES_DB=
+    POSTGRES_USER=
+    POSTGRES_PASSWORD=
+    DB_URL=
+    TEST_DB_URL=
+    PRODUCTION_DB_URL=
+`,
+};
+
+const gitignoreFile: IFile = {
+  name: ".gitignore",
+  content: `# Add more as needed
+  /database
+  ./database`,
+};
+
+const readmeFile: IFile = {
+  name: "README.md",
+  content: `# Go Setup Project
+  This is a Go project scaffolded using Go Setup.
+  
+  ## Setup Instructions
+  1. Ensure you have Go installed on your machine.
+  2. Navigate to the project directory.
+  3. Run \`go mod tidy\` to install dependencies.
+  
+  ## Project Structure
+  - \`internal/\`: Contains internal application code.
+  - \`migrations/\`: Database migration files.
+  
+  ## Usage
+  - To run the application, use \`go run main.go\`.
+  
+  ## License
+  This project is licensed under the MIT License.
+`,
+};
+
+const mainGoFile: IFile = {
+  name: "main.go",
+  content: `package main
+  import "fmt"
+
+    func main() {
+        fmt.Println("Hello, Go Setup!")
+    }
+`,
+};
+
+const dockerfile: IFile = {
+  name: "Dockerfile",
+  content: `# Use the official Golang image as a base image
+    # Build stage
+    FROM golang:1.24-alpine AS builder
+
+    WORKDIR /app
+
+    # Copy go mod files
+    COPY go.mod go.sum ./
+    RUN go mod download
+
+    # Copy source code
+    COPY . .
+
+    # Build the application
+    RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o main .
+
+    # Production stage
+    FROM alpine:latest
+
+    RUN apk --no-cache add ca-certificates
+
+    WORKDIR /root/
+
+    # Copy the binary from builder
+    COPY --from=builder /app/main .
+    COPY --from=builder /app/migrations ./migrations
+
+    EXPOSE 8080
+
+    CMD ["./main"]
+`,
+};
+
+const dockerComposeFile: IFile = {
+  name: "docker-compose.yml",
+  content: `
+version: "3.8"
+
+services:
+  db:
+    container_name: "db"
+    image: postgres:12.4-alpine
+    volumes:
+      - "./database/postgres-data:/var/lib/postgresql/data:rw"
+    ports:
+      - "5432:5432"
+    environment:
+      POSTGRES_DB: postgres
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+    restart: unless-stopped
+  test_db:
+    container_name: "test_db"
+    image: postgres:12.4-alpine
+    volumes:
+      - "./database/postgres-test-data:/var/lib/postgresql/data:rw"
+    ports:
+      - "5433:5432"
+    environment:
+      POSTGRES_DB: postgres
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+    restart: unless-stopped
+    `,
+};
+
+const userHandlerFile: IFile = {
+  name: "user_handler.go",
+  content: `package api`,
+};
+
+const tokenHandlerFile: IFile = {
+  name: "token_handler.go",
+  content: `package api`,
+};
+
+const appFile: IFile = {
+  name: "app.go",
+  content: `package app`,
+};
+
+const middlewareFile: IFile = {
+  name: "middleware.go",
+  content: `package middleware`,
+};
+
+const utilsFile: IFile = {
+  name: "utils.go",
+  content: `package utils`,
+};
+
+const tokenFile: IFile = {
+  name: "token.go",
+  content: `package tokens`,
+};
+
+const routesFile: IFile = {
+  name: "routes.go",
+  content: `package routes`,
+};
+
+const storeFile: IFile = {
+  name: "db.go",
+  content: `package stores`,
+};
+const userStoreFile: IFile = {
+  name: "user_store.go",
+  content: `package stores`,
+};
+const tokenStoreFile: IFile = {
+  name: "token_store.go",
+  content: `package stores`,
+};
+
+const userMigrationFile: IFile = {
+  name: "00001_users.sql",
+  content: `
+-- +goose Up
+-- +goose StatementBegin
+
+-- Enable UUID extension for gen_random_uuid()
+CREATE EXTENSION IF NOT EXISTS "pgcrypto";
+
+CREATE TABLE  IF NOT EXISTS users (
+    id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
+    username VARCHAR(50),
+    mobile_number VARCHAR(13),
+    hashed_password VARCHAR(255),
+    account_id VARCHAR(100),
+    profile_image_url VARCHAR(2048),
+    created_at TIMESTAMPTZ DEFAULT CURRENT_TIMESTAMP,
+    updated_at TIMESTAMPTZ DEFAULT CURRENT_TIMESTAMP,
+    deleted_at TIMESTAMPTZ
+);
+-- +goose StatementEnd
+
+-- +goose Down
+-- +goose StatementBegin
+DROP TABLE IF EXISTS users;
+-- +goose StatementEnd
+`,
+};
+
+const tokenMigrationFile: IFile = {
+  name: "00002_tokens.sql",
+  content: `
+-- +goose Up
+-- +goose StatementBegin
+CREATE TABLE IF NOT EXISTS tokens (
+    hash BYTEA PRIMARY KEY,
+    user_id UUID NOT NULL REFERENCES users(id) ON DELETE CASCADE,
+    merchant_id UUID NOT NULL REFERENCES merchants(id) ON DELETE CASCADE,
+    expiry TIMESTAMP WITH TIME ZONE NOT NULL,
+    scope VARCHAR(255) NOT NULL
+)
+-- +goose StatementEnd
+
+-- +goose Down
+-- +goose StatementBegin
+DROP TABLE tokens;
+-- +goose StatementEnd
+  `,
+};
+
+const fsMigrationFile: IFile = {
+  name: "fs.go",
+  content: `package migrations
+
+import (
+	"embed"
+)
+
+//go:embed *.sql
+var FS embed.FS`,
+};
+
+const internalDirectories: IDirectory[] = [
+  {
+    name: "api",
+    files: [userHandlerFile, tokenHandlerFile],
+  },
+  {
+    name: "app",
+    files: [appFile],
+  },
+  {
+    name: "middleware",
+    files: [middlewareFile],
+  },
+  {
+    name: "utils",
+    files: [utilsFile],
+  },
+  {
+    name: "tokens",
+    files: [tokenFile],
+  },
+  {
+    name: "routes",
+    files: [routesFile],
+  },
+  {
+    name: "stores",
+    files: [storeFile, userStoreFile, tokenStoreFile],
+  },
+];
+
+const internalDirectory: IDirectory = {
+  name: "internal",
+  subdirectories: internalDirectories,
+  files: [],
+};
+
+const migrationsDirectory: IDirectory = {
+  name: "migrations",
+  files: [fsMigrationFile, userMigrationFile, tokenMigrationFile],
+};
+
+const RootFiles: IFile[] = [
+  readmeFile,
+  gitignoreFile,
+  mainGoFile,
+  envLocalFile,
+  dockerfile,
+  dockerComposeFile,
+];
+
+export const RootDirectory: IDirectory = {
+  name: ".",
+  subdirectories: [migrationsDirectory, internalDirectory],
+  files: RootFiles,
+};

package/src/utils/types.ts

@@ -0,0 +1,12 @@
+interface IFile {
+  name: string;
+  content?: string;
+}
+
+interface IDirectory {
+  name: string;
+  subdirectories?: IDirectory[];
+  files: IFile[];
+}
+
+export type { IFile, IDirectory };

package/src/utils/utils.ts

@@ -0,0 +1,32 @@
+import { $ } from "bun";
+import type { IDirectory } from "./types";
+
+export enum Mode {
+  LIGHT = "#fef7f7",
+  DARK = "#020202",
+}
+
+export async function createDirectoryStructure(
+  directory: IDirectory,
+  basePath: string
+): Promise<void> {
+  const currentPath =
+    directory.name === "." ? basePath : `${basePath}/${directory.name}`;
+
+  if (directory.name !== ".") {
+    await $`mkdir -p ${currentPath}`;
+  }
+
+  if (directory.files && directory.files.length > 0) {
+    for (const file of directory.files) {
+      const filePath = `${currentPath}/${file.name}`;
+      await Bun.write(filePath, file.content ?? "");
+    }
+  }
+
+  if (directory.subdirectories && directory.subdirectories.length > 0) {
+    for (const subdir of directory.subdirectories) {
+      await createDirectoryStructure(subdir, currentPath);
+    }
+  }
+}