Skip to content

spiralhq/spiral

Repository files navigation

spiral

This project was created with Better-T-Stack, a modern TypeScript stack that combines Next.js, Hono, TRPC, and more.

Features

  • TypeScript - For type safety and improved developer experience
  • Next.js - Full-stack React framework
  • TailwindCSS - Utility-first CSS for rapid UI development
  • shadcn/ui - Reusable UI components
  • Hono - Lightweight, performant server framework
  • tRPC - End-to-end type-safe APIs
  • Node.js - Runtime environment
  • Drizzle - TypeScript-first ORM
  • PostgreSQL - Database engine
  • Authentication - Better-Auth
  • Turborepo - Optimized monorepo build system
  • Oxlint - Oxlint + Oxfmt (linting & formatting)

Getting Started

First, install the dependencies:

npm install

Database Setup

This project uses PostgreSQL with Drizzle ORM.

  1. Make sure you have a PostgreSQL database set up.

  2. Update your apps/server/.env file with your PostgreSQL connection details.

  3. Apply the schema to your database:

npm run db:push

Then, run the development server:

npm run dev

Open http://localhost:3001 in your browser to see the web application. The API is running at http://localhost:3000.

Git Hooks and Formatting

  • Format and lint fix: npm run check

Project Structure

spiral/
├── apps/
│   ├── web/         # Frontend application (Next.js)
│   └── server/      # Backend API (Hono, TRPC)
├── packages/
│   ├── api/         # API layer / business logic
│   ├── auth/        # Authentication configuration & logic
│   └── db/          # Database schema & queries

Available Scripts

  • npm run dev: Start all applications in development mode
  • npm run build: Build all applications
  • npm run dev:web: Start only the web application
  • npm run dev:server: Start only the server
  • npm run check-types: Check TypeScript types across all apps
  • npm run db:push: Push schema changes to database
  • npm run db:studio: Open database studio UI
  • npm run check: Run Oxlint and Oxfmt

Releases

No releases published

Packages

 
 
 

Contributors