Skip to content

TechSquidTV/Inkling

Repository files navigation

Inkling (Vibe App Template)

The perfect personal software template for your next self-hosted project. A custom Go + React stack built for ease of use and speed.

inkling.mp4

Why does this exist?

When building personal apps, I found myself often wasting a lot of time and tokens rebuilding similar boilerplate code for each app. With this app template, you can begin building all of your personal apps right away with a consistent clean, and fast base.

✨ Features

  • 🔐 Robust Auth: OIDC (OpenID Connect) for SSO and secure API Key authentication.
  • ⚡️ Modern UI: Built with Shadcn UI + Animate-UI.
  • 🎨 Themable: Easily customizable design system built on Tailwind CSS v4.
  • 🚀 AI-Ready: Well documented and prepared for AI Agents.
  • 📦 SQLite Powered: Zero-config database setup with GORM.
  • 🔥 Hot Reload: Development servers with hot reload for instant feedback.
  • 🛠 Tooling: Makefile for dev/build workflow.
  • 🏃‍♂️‍➡️ FAST: Go backend for fast performance and low resource usage.
  • 📦 Single Binary: The backend is compiled into a single binary for easy deployment.
  • 📊 Log Viewer: Real-time application logs. Disabled by default.
  • 👀 Observability: OpenTelemetry on the backend + Sentry on the frontend.

🚀 Quick Start

Prerequisites

Installation

  1. Clone the repository:
    git clone git@github.com:TechSquidTV/Inkling.git
    cd Inkling
  2. Customize:
    make init
  3. Install dependencies:
    make install
  4. Start the development servers:
    make dev

Customizing the App

Modify the web/src/constants.ts file to change the app name, logo, description, and other metadata.


🛠 Tech Stack

Frontend:

Backend:


📖 Documentation

Explore the following for more details:


AI Agent Support

This project contains an AGENTS.md file in the root directory with basic project context for AI Agents to use. Not all AI Agents respect this file, you may need to add an additional rule file for your agent that points to this file.

Recommended MCP Servers


FAQ

Why Go + React?

React is not only the most popular frontend framework, supporting the most tooling and community, but is also the framework most LLM Agents will excel at. Typically you might pair this with a Node.js Backend or use Next.js, but not knowing a lower level language like Go is no longer a barrier with AI-assisted coding. We use Go for its efficiency, small size, and ridiculous speed.

Why not Rust?

image

Why not Next.js?

Because Go is faster.

📜 License

MIT License.

About

A vibe-coding app template for self-hosted tools

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published