MAD Framework
MAD NL
  • Introduction
  • Getting Started
    • Installation
    • Frontend
  • The Basics
    • Requests
    • Responses
    • Controllers
    • Views
    • Database
    • Session
    • Pagination
    • Helpers
  • Security
    • Authentication
    • CSRF Protection
    • Validation
    • Middleware
    • Exception Handling
Powered by GitBook
On this page
  1. Getting Started

Installation

PreviousIntroductionNextFrontend

Last updated 6 months ago

Ensure Composer is Installed Before installing the framework, ensure that is installed on your system. Composer is essential for managing dependencies.Before installing the framework, make sure that you have got composer installed.

Install the Framework To install the framework, execute the following command in your terminal:Installing could be done through this command

composer require mad-sy/mad_framework --yourcustomname

Optional: Install Tailwind CSS If you plan to use Tailwind CSS, we’ve provided a pre-configured package that includes commonly used components such as navigation and authentication forms. To set it up, run the following commands:

npm install

npm run dev

Database Setup

The next step is to set up the necessary database tables. In the database folder, you will find a SQL file containing the table definitions. Copy the contents of this file and run the migration through your SQL command line to create the required tables.

Important: Ensure your database credentials in the .env file are correct to establish a proper connection.

Run the Application To run the application locally, you have two options:

  • You can use Laravel Herd if you have it installed.

  • Alternatively, you can start the built-in PHP server by running

php -S localhost:127.0.0.1

Composer