Welcome to Charifund Nonprofit NGO Fundraising Documentation !

Introduction

Welcome to the Charifund Nonprofit NGO Fundraising System.

Charifund is a modern, flexible, and feature-rich nonprofit fundraising platform built with Laravel 12. It is designed to help organizations, charities, and NGOs efficiently manage donations, campaigns, and supporters through a secure and scalable system.

The system is developed with clean code architecture, scalability in mind, and follows Laravel best practices to ensure smooth development, easy customization, and long-term maintainability.

This documentation will guide you through:

  • Installation and setup
  • Project structure overview
  • Configuration and environment setup
  • Core features and modules
  • Customization guidelines
  • Common issues and solutions

Whether you are a developer integrating Charifund into a live project or customizing it for a client, this guide will help you understand the system clearly and work efficiently.

Let’s get started with building a powerful and professional fundraising platform using Charifund.

Installation

To setup the theme, follow the steps below

  • The zip file contains all files integrated with Charifund Nonprofit NGO Fundraising Html Template, however you need to perform the following steps to set up your Laravel project:
  • Ensure you have Composer installed on your machine. If not already installed, download and install Composer.
  • Note: Make sure all installation processes are executed in your terminal.
  • Extract the contents of the zip file to your desired directory.
  • Open your terminal and navigate to the project directory.
  • Run the following command to install dependencies: composer install
  • Create a copy of the .env.example file and rename it to .env.
  • Generate an application key by running: php artisan key:generate
  • Run migrations to set up your database: php artisan migrate
  • Start the development server: php artisan serve
  • Your Laravel application is now running locally. Access it in your browser at http://localhost:8000
  • Note: For more advanced configuration, refer to the Laravel documentation.
  • Feel free to reach out for any further assistance. Support

File Structure

├──  Hostie/
│   ├──  app/
│   ├──  Http/
│   │   ├──  Controllers/
│   │   │   └── All Controllers are located within this directory.
│   │   ├──  Models/
│   │   │   └── All Migration Models are located within this directory.
│   ├──  bootstrap/
│   ├──  config/
│   │   │   └── Configuration like Payment, AWS files are located here.
│   ├──  database/
│   │   ├──  migrations/
│   │   │   └── Contains migration files for database schema changes.
│   │   ├──  seeders/
│   │   │   └── Seeder files for populating initial/default data.
│   ├──  public/
│   │   ├──  assets/
│   │   │   ├──  css/
│   │   │   ├──  js/
│   │   │   ├──  fonts/
│   │   │   └──  scss/
│   │   ├──  .htaccess
│   │   │   └── HTTP/HTTPS access configurations.
│   │   ├──  index.php
│   │   │   └── Primary file executed by the server.
│   ├──  resources/
│   │   ├──  views/
│   │   │   └── Blade template files for frontend views.
│   ├──  routes/
│   │   ├──  web.php
│   │   │   └── Defines project routes.
│   ├──  storage/
│   │   ├──  logs/
│   │   │   └── Error logs for debugging.
│   ├──  .env
│   │   │   └── Environment variables configuration.
│   ├──  artisan
│   ├──  composer.json
│   ├──  phpunit.xml
│   ├──  vite.config.js
├──  Documentation/
│   └──  index.html - Index file for documentation.
                                    

HTML Structure

<!DOCTYPE html>
<html lang="en">

<head>
    <!-- Stylesheet, Meta Tag, Title -->
    @include('frontend.includes.partials.head')
    @yield('css')
</head>

<body class="{{ $bodyClass ?? '' }}">
    <!-- Start Content Area -->
    @yield('content')
    <!-- End Content Area -->

    <!-- Start Script Area -->
    @include('frontend.includes.partials.scripts')
    @yield('script')
    <!-- End Script Area -->
</body>

</html>
                                            

Css & Javascript

CSS

All CSS is included in the style.css file.

File Name Details
css/style.css Custom Style CSS

JavaScript

All JS is included in the main.js file.

File Name Details
js/main.js All Custom JS

Credit & Resources

We have used the following plugins:

Thank You

24/7 Support: Send Us a message from our Support Page

Thank you so much for purchasing our Laravel Template!🎉

If you have any queries, suggestions, or complaints, contact us anytime. If you have any questions that are beyond the scope of this documentation, please feel free to email us via our Support Page: Support

We're here to help you at every step of the way and make your experience as smooth as possible.

We hope this documentation serves you well!🙌

Enjoy your coding journey!✨