First-Time Setup
When you visit the admin dashboard at http://localhost:3000 for the first time, GritCMS walks you through an initial setup wizard. This only runs once and configures the essentials for your site.
Create Your Admin Account
The first screen asks you to create the administrator account. Enter your name, email, and a strong password. This account has full access to every module and setting in the system.
Configure Site Settings
Next, configure the basic identity of your site:
- Site Name -- the name displayed in the header, browser tab, and emails (e.g., "My Creator Hub")
- Tagline -- a short description shown on your homepage and in meta tags
- Logo -- upload your brand logo (displayed in the admin sidebar and public site header)
These settings can be changed later from Settings > General in the admin dashboard.
Dashboard Overview
After setup, you land on the admin dashboard. This is your command center with quick access to every module.
Key Sections in the Sidebar
| Section | What it does |
|---|---|
| Dashboard | Overview metrics, recent activity, quick actions |
| Pages | Create and manage website pages |
| Blog | Write and publish blog posts |
| Manage lists, subscribers, and campaigns | |
| Courses | Build and sell online courses |
| Products | Manage digital/physical products and orders |
| Contacts | CRM with tags, segments, and activity tracking |
| Community | Spaces, threads, and community events |
| Funnels | Sales funnels with conversion tracking |
| Booking | Calendars, event types, and appointments |
| Affiliates | Affiliate programs, links, and commissions |
| Workflows | Event-driven automation rules |
| Settings | Site configuration, integrations, and appearance |
Command Search
Press Ctrl+K (or Cmd+K on macOS) anywhere in the admin to open the command search. This lets you quickly jump to any page, create new content, or search across your entire dashboard without navigating through menus.
Quick Action: Create a Page
- Navigate to Pages in the sidebar.
- Click New Page.
- Enter a title (the slug is auto-generated from the title).
- Use the block editor to add content -- text, images, buttons, and embeds.
- Click Publish to make the page live on your public website.
Your page is immediately visible at http://localhost:3001/pages/your-page-slug.
Quick Action: Write a Blog Post
- Navigate to Blog in the sidebar.
- Click New Post.
- Fill in the title, excerpt, and featured image.
- Write your content using the rich text editor.
- Assign categories and tags for organization.
- Click Publish to make it live.
Published posts appear on your public blog at http://localhost:3001/blog.
Quick Action: Create a Course
- Navigate to Courses in the sidebar.
- Click New Course.
- Enter the course title, description, thumbnail, and pricing.
- Add modules to organize your content into sections.
- Inside each module, add lessons with text, video, or downloadable content.
- Toggle the course to Published when ready.
Students can browse and enroll in courses on your public site. Track enrollment and progress from the admin.
Quick Action: Set Up Email Marketing
- Navigate to Email in the sidebar.
- Create a new List (e.g., "Newsletter Subscribers").
- Add subscribers manually or let them sign up through your public website.
- Create a Campaign to send a broadcast email to your list.
- Track opens, clicks, and unsubscribes from the campaign analytics view.
Make sure your email/SMTP settings are configured before sending.
Quick Action: Add a Product
- Navigate to Products in the sidebar.
- Click New Product.
- Set the product name, description, images, and price.
- Choose the product type: digital download, physical product, or subscription.
- Optionally create coupons for discounts.
- Publish the product to your storefront.
Built-In Developer Tools
GritCMS ships with several built-in tools accessible from the API server:
| Tool | URL | Purpose |
|---|---|---|
| API Docs | http://localhost:8080/docs | Interactive REST API documentation |
| GORM Studio | http://localhost:8080/studio | Visual database browser and editor |
| Pulse | http://localhost:8080/pulse/ui/ | Performance monitoring dashboard |
| Sentinel | http://localhost:8080/sentinel/ui | Security WAF and threat detection |
Next Steps
Now that you have GritCMS running, dive deeper into the modules that matter most to you:
- Website Builder -- pages, blog, and navigation
- Email Marketing -- lists, campaigns, and automations
- Course Platform -- building and selling courses
- Products & Commerce -- storefront and orders
- Contacts CRM -- managing your audience
- Community -- building engaged communities
- Sales Funnels -- conversion-optimized funnels
- Booking & Scheduling -- calendars and appointments
- Affiliate Management -- referral programs
- Workflow Automation -- event-driven automations
- Configuration -- environment variables and setup