Installation

PreviousNext

Learn how to set up Church Ledger locally.

Installation

Follow these steps to set up Church Ledger on your local machine for development or testing.

Prerequisites

Before you begin, ensure you have the following installed:

  • PHP 8.3 or higher
  • Composer (PHP package manager)
  • Node.js (Latest LTS recommended)
  • pnpm (Fast, disk space efficient package manager)
  • Supabase Account (or a local PostgreSQL instance)

Getting Started

Clone the repository

First, clone the Church Ledger repository to your local machine:

git clone https://github.com/veikeAgency/church-ledger.git
cd church-ledger

Install PHP dependencies

Use Composer to install the backend dependencies:

composer install

Install JavaScript dependencies

Use pnpm to install the frontend dependencies:

pnpm install

Environment Setup

Copy the example environment file and generate a new application key:

cp .env.example .env
php artisan key:generate

Database Setup

Run the migrations to create the necessary database tables:

php artisan migrate

Start the Development Server

You can start the backend, queue listener, and frontend simultaneously using the following command:

composer run dev

This will start:

  • Laravel Server: http://localhost:8000
  • Vite (Frontend): http://localhost:5173
  • Queue Listener: For background jobs

Common Issues

Previous
Next