Documentation

ExoCRM Documentation
Learn how to use and customize the ExoCRM template

Welcome to the ExoCRM documentation. This guide will help you understand how to use and customize the CRM template to fit your needs.

Installation & Setup
How to install and set up the ExoCRM template

Prerequisites

  • Node.js 16.8 or later
  • npm or yarn package manager
  • Basic knowledge of React and Next.js

Installation Steps

# Clone the repository
git clone https://github.com/exocodelab/exocrm.git

# Navigate to the project directory
cd exocrm

# Install dependencies
npm install

# Start the development server
npm run dev

Project Structure

/src
├── app/                # Next.js App Router
│   ├── (dashboard)/   # Dashboard routes
│   ├── api/          # API routes
│   ├── login/        # Authentication pages
│   └── layout.tsx    # Root layout
├── components/        # Reusable UI components
│   ├── charts/       # Chart components
│   ├── dashboard/    # Dashboard-specific components
│   ├── layout/       # Layout components
│   └── ui/           # UI components
├── features/         # Redux slices for each entity
├── lib/             # Utility functions
├── api/             # API integration
└── store/           # Redux store configuration

Configuration

The main configuration files are:

  • next.config.js - Next.js configuration
  • tailwind.config.js - Tailwind CSS configuration
  • lib/theme-config.ts - Theme configuration