Getting Started

Getting Started with SlappShell serviceCRM

Welcome to SlappShell serviceCRM! This guide will help you set up your self-hosted instance in a few minutes.

Introduction

serviceCRM is a powerful boilerplate that gives you a self-hosted all-in-one platform made especially for leads and service-based businesses. With minimal configuration, you have complete control over your public site, your data, and your and infrastructure.

It is designed for a quick set up that you can launch and start running campaigns to your service landing pages right away. After that, your options for customization and expansion are endless.

Quick Start Guide

Follow these steps to get your instance running in minutes:

1. Prerequisites Check: Ensure you have Node.js v20.9+ installed.
2. Repo Access: Enure you have access to the SlappShell serviceCRM repository
3. Configure Environment: Set up your environment variables & config files
4. Deploy: Launch on Vercel or your preferred hosting provider

For a detailed video walkthrough, check out our Installation Walkthrough.

System Requirements & External Services

Before installing, make sure your system meets the minimum requirements & you're ready with the necessary external services:

• Minimum Node.js version: 20.9+
• Framework Familiarity: Not required, but some familiary with the Next.js App Router is helpful
• Storage & Auth: Supabase database
• Email Service: Resend account for emails
• Payment Processor: Stripe account for handling payments
• Hosting Provider: Vercel, Netlify, Render, or similar

Project Structure

serviceCRM is built using the Next.js App Router with a straightforward file structure:

/
├── /app/                  
├── /components/           
├── /config/               
├── /emails/               
├── /lib/                  
├── /public/               
├── /styles/               
└── /supabase/
 ...

app Next.js App Router pages and API routes

components Reusable React components, client components, and UI elements

config Configuration files for business, payment, scheduling, services, and forms

emails React Email Templates and Components

lib Utility functions and services

public Static assets (images, fonts, etc.)

styles Theme styles

supabase Supabase database migration scripts

# Check Node.js version
node -v

# Clone the repository
$ git clone https://github.com/WaveArcade/slappshell_ServiceCRM [your-folder-name]

# Navigate into the project directory
$ cd [your-folder-name]

# Install dependencies
$ npm install

# Set Up Your Own Git Repository
$ git remote remove origin
$ git init
$ git add .
$ git commit -m "Initial commit"
$ git branch -M main
$ git remote add origin [your-repo-url]
$ git push -u origin main

# Configure Environment Variables & Config Files
# Start the development server
$ npm run dev