feat: update docker setup (#985)

* feat: setup docker

* chore: fix lint

* chore: bump pnpm

* chore: update css variables

Author: sadmann7

.env.example

@@ -1,9 +1,9 @@
 # Database
-DATABASE_URL="postgres://YOUR_POSTGRESQL_URL"
+# If not using docker, set DATABASE_URL to hosted postgres url and ignore the other database variables.
+DATABASE_URL="postgresql://tablecn:securepassword@localhost:5432/tablecn"
 
-## Docker compose (optional)
-DB_HOST=localhost
-DB_USER=shadcntable
-DB_PASSWORD=securepassword
-DB_NAME=shadcntable
-DB_PORT=5432
+DATABASE_HOST="localhost"
+DATABASE_USER="tablecn"
+DATABASE_PASSWORD="securepassword"
+DATABASE_NAME="tablecn"
+DATABASE_PORT="5432"

.github/setup/action.yml

@@ -10,7 +10,7 @@ runs:
     - name: Setup pnpm
       uses: pnpm/action-setup@v4
       with:
-        version: 10.9.0
+        version: 10.12.4
 
     - run: pnpm install
       shell: bash

.github/workflows/code-check.yml

@@ -22,7 +22,7 @@ jobs:
       - name: Setup pnpm
         uses: pnpm/action-setup@v4
         with:
-          version: 10.9.0
+          version: 10.12.4
       - uses: ./.github/setup
 
       - name: Check formatting
@@ -37,7 +37,7 @@ jobs:
       - name: Setup pnpm
         uses: pnpm/action-setup@v4
         with:
-          version: 10.9.0
+          version: 10.12.4
       - uses: ./.github/setup
 
       - run: pnpm lint
@@ -51,7 +51,7 @@ jobs:
       - name: Setup pnpm
         uses: pnpm/action-setup@v4
         with:
-          version: 10.9.0
+          version: 10.12.4
       - uses: ./.github/setup
 
       - run: pnpm typecheck

.vscode/settings.json

@@ -9,10 +9,5 @@
     ["clsx\\(([^)]*)\\)", "[\"'`]([^\"'`]*).*?[\"'`]"],
     ["cva\\(((?:[^()]|\\([^()]*\\))*)\\)", "[\"'`]?([^\"'`]+)[\"'`]?"],
     ["cn\\(((?:[^()]|\\([^()]*\\))*)\\)", "(?:'|\"|`)([^']*)(?:'|\"|`)"]
-  ],
-  "markdownlint.config": {
-    "MD033": {
-      "allowed_elements": ["div", "a", "img", "br"]
-    }
-  }
+  ]
 }

README.md

@@ -4,13 +4,7 @@ This is a shadcn table component with server-side sorting, filtering, and pagina
 
 [![Shadcn Table](./public/images/screenshot.png)](https://tablecn.com)
 
-<div align="center">
-  <a href="https://vercel.com/oss">
-    <img alt="Vercel OSS Program" src="https://vercel.com/oss/program-badge.svg" />
-  </a>
-</div>
-
-<br />
+[![Vercel OSS Program](https://vercel.com/oss/program-badge.svg)](https://vercel.com/oss)
 
 ## Documentation
 
@@ -38,46 +32,78 @@ See the [documentation](https://diceui.com/docs/components/data-table) to get st
 
 ## Running Locally
 
-1. Clone the repository
+### Quick Setup
+
+For first-time setup, run this single command:
+
+1. **Clone the repository**
 
    ```bash
    git clone https://github.com/sadmann7/shadcn-table
+   cd shadcn-table
    ```
 
-2. Install dependencies using pnpm
+2. **Copy the environment variables**
 
    ```bash
-   pnpm install
+   cp .env.example .env
    ```
 
-3. Copy the `.env.example` to `.env` and update the variables.
+3. **Run the setup**
 
    ```bash
-   cp .env.example .env
+   pnpm ollie
    ```
 
-4. (Optional) Run database using docker-compose.yml file
+   This will install dependencies, start the Docker PostgreSQL instance, set up the database schema, and seed it with sample data.
+
+### Manual Setup
+
+1. **Clone the repository**
 
    ```bash
-   docker compose up
+   git clone https://github.com/sadmann7/shadcn-table
+   cd shadcn-table
    ```
 
-5. Push the database schema
+2. **Install dependencies**
 
    ```bash
-   pnpm run db:push
+   pnpm install
+   ```
+
+3. **Set up environment variables**
+
+   ```bash
+   cp .env.example .env
    ```
 
-6. Seed the database
+   Update the `.env` file with your database credentials.
+
+4. **Choose your database approach:**
+
+   **Option A: Use Docker PostgreSQL**
 
    ```bash
-   pnpm run db:seed
+   # Start PostgreSQL container
+   pnpm db:start
+   
+   # Set up database schema and seed data
+   pnpm db:setup
+   
+   # Start development server
+   pnpm dev
    ```
 
-7. Start the development server
+   **Option B: Use existing PostgreSQL database**
 
    ```bash
-   pnpm run dev
+   # Update .env with your database URL
+   # Then set up database schema and seed data
+   pnpm db:setup
+   
+   # Start development server
+   pnpm dev
    ```
 
 ## How do I deploy this?

docker-compose.yml

@@ -1,16 +1,17 @@
 services:
-  shadcn-table:
+  postgres:
     image: postgres:17.4
     restart: always
-    container_name: shadcn-table
     ports:
-      - ${DB_PORT}:5432
+      - ${DATABASE_PORT}:5432
     environment:
-      - POSTGRES_PASSWORD=${DB_PASSWORD}
-      - POSTGRES_USER=${DB_USER}
-      - POSTGRES_DB=${DB_NAME}
+      - POSTGRES_PASSWORD=${DATABASE_PASSWORD}
+      - POSTGRES_USER=${DATABASE_USER}
+      - POSTGRES_DB=${DATABASE_NAME}
     volumes:
       - ./docker-data/db:/var/lib/postgresql/data
-
-volumes:
-  postgres:
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U ${DATABASE_USER} -d ${DATABASE_NAME}"]
+      interval: 10s
+      timeout: 5s
+      retries: 5

package.json

@@ -7,19 +7,25 @@
     "clean": "rimraf --glob **/node_modules **/dist **/.next pnpm-lock.yaml **/.tsbuildinfo",
     "build": "next build",
     "dev": "next dev",
+    "dev:docker": "pnpm db:start && pnpm dev",
     "start": "next start",
+    "ollie": "pnpm install && pnpm run db:start && pnpm run db:setup",
     "lint": "biome check .",
     "lint:fix": "biome check . --write",
     "typecheck": "tsc --noEmit",
     "check": "pnpm lint && pnpm typecheck",
     "shadcn": "pnpm dlx shadcn@latest",
     "build:registry": "shadcn build",
+    "db:start": "docker compose up -d",
+    "db:stop": "docker compose down",
     "db:generate": "dotenv drizzle-kit generate",
     "db:introspect": "dotenv drizzle-kit introspect",
     "db:push": "dotenv drizzle-kit push",
     "db:migrate": "dotenv tsx src/db/migrate.ts",
     "db:drop-migration": "drizzle-kit drop",
     "db:seed": "dotenv tsx src/db/seed.ts",
+    "db:setup": "pnpm db:push && pnpm db:seed",
+    "db:reset": "pnpm db:stop && rimraf docker-data && pnpm db:start && sleep 10 && pnpm db:setup",
     "db:studio": "dotenv drizzle-kit studio"
   },
   "dependencies": {
@@ -89,5 +95,5 @@
   "ct3aMetadata": {
     "initVersion": "7.23.1"
   },
-  "packageManager": "pnpm@10.9.0"
+  "packageManager": "pnpm@10.12.4"
 }