Installation

Prerequisites

Before installing Grmlin, make sure you have:

• Node.js 18 or later
• A package manager (npm, yarn, or pnpm)
• A database (PostgreSQL, MySQL, or SQLite)

Framework Installation

Next.js

1. Create a new Next.js project

   npx create-next-app@latest my-grmlin-app
   cd my-grmlin-app

2. Install Grmlin

   npm install @grmlin/core @grmlin/ui @grmlin/cli

3. Initialize Grmlin

   npx grmlin init

4. Configure your database

   Add your database configuration to .env.local:

   .env.local

   DATABASE_URL="postgresql://username:password@localhost:5432/mydb"
   GREMLIN_SECRET="your-secret-key"

Nuxt.js

1. Create a new Nuxt.js project

   npx nuxi@latest init my-grmlin-app
   cd my-grmlin-app

2. Install Grmlin

   npm install @grmlin/nuxt @grmlin/core

3. Add the Nuxt module

   nuxt.config.ts

   export default defineNuxtConfig({
     modules: ['@grmlin/nuxt'],
     grmlin: {
       // Configuration options
     },
   });

4. Configure environment variables

   .env

   DATABASE_URL="postgresql://username:password@localhost:5432/mydb"
   GREMLIN_SECRET="your-secret-key"

SvelteKit

1. Create a new SvelteKit project

   npm create svelte@latest my-grmlin-app
   cd my-grmlin-app
   npm install

2. Install Grmlin

   npm install @grmlin/sveltekit @grmlin/core

3. Configure SvelteKit adapter

   vite.config.js

   import { sveltekit } from '@sveltejs/kit/vite';
   import { grmlin } from '@grmlin/sveltekit';
   
   export default {
     plugins: [sveltekit(), grmlin()],
   };

4. Set up environment variables

   .env

   DATABASE_URL="postgresql://username:password@localhost:5432/mydb"
   GREMLIN_SECRET="your-secret-key"

Astro

1. Create a new Astro project

   npm create astro@latest my-grmlin-app
   cd my-grmlin-app

2. Install Grmlin

   npm install @grmlin/astro @grmlin/core

3. Configure Astro integration

   astro.config.mjs

   import { defineConfig } from 'astro/config';
   import grmlin from '@grmlin/astro';
   
   export default defineConfig({
     integrations: [grmlin()],
   });

4. Add environment variables

   .env

   DATABASE_URL="postgresql://username:password@localhost:5432/mydb"
   GREMLIN_SECRET="your-secret-key"

React

1. Create a new React project

   npx create-react-app my-grmlin-app
   cd my-grmlin-app

2. Install Grmlin

   npm install @grmlin/react @grmlin/core

3. Set up Grmlin provider

   src/App.tsx

   import { GrmlinProvider } from '@grmlin/react';
   
   function App() {
     return (
       <GrmlinProvider config={{ apiUrl: '/api' }}>
         {/* Your app components */}
       </GrmlinProvider>
     );
   }

4. Configure environment variables

   .env

   REACT_APP_DATABASE_URL="postgresql://username:password@localhost:5432/mydb"
   REACT_APP_GREMLIN_SECRET="your-secret-key"

Database Setup

Tip

Grmlin supports PostgreSQL, MySQL, and SQLite. We recommend PostgreSQL for production applications.

PostgreSQL

# Install PostgreSQL (macOS)
brew install postgresql
brew services start postgresql

# Create a database
createdb my-grmlin-db

MySQL

# Install MySQL (macOS)
brew install mysql
brew services start mysql

# Create a database
mysql -u root -p -e "CREATE DATABASE my_grmlin_db;"

SQLite

For development, you can use SQLite which requires no additional setup:

.env

DATABASE_URL="file:./dev.db"

Verification

After installation, verify everything is working:

npx grmlin generate
npx grmlin migrate
npm run dev

Visit your application and you should see the Grmlin admin interface at /admin.

Next Steps

• Configure your first content models
• Learn about the API
• Check out examples

Caution

Make sure to keep your GREMLIN_SECRET environment variable secure and never commit it to version control.