MAW11_MUGIWARAS

An awesome framework to create a website !

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation

About The Project

This is a php web framework that uses the MVC pattern. It is a project for the Web Applications Development course at the CPNV. The goal of this project is to create a framework that should ease the creation of a website.

Getting Started

Prerequisites

• PHP 8.2.9 (TS)
• xdebug 3.2.2
• composer 2.6.2

How to install the requirements

PHP

Use your favourite package manager to install PHP 8.2.9 (TS). Or follow this link that redirects to the official PHP download page.

xdebug

Follow this link that redirects to the official xdebug install documentation.

composer

Follow this link that redirects to the official composer download page.

Installation

Installing as a composer package

1. add the repository to your composer.json

{
  "require": {
      "mugiwaras/framework": "dev-main"
    },
  "repositories": [
    {
      type": "vcs",
      url": "https://github.com/CPNV-ES/MAW11_Mugiwaras_Framework"
    }
  ]
}

2. Then use composer to install the package

composer install 

3. copy the .env.example or set the required environment variables that you can find in the vendor under Mugiwaras\framework.env.example

4. All done, you can now use the framework as you wish !

Working as a contributor

1. Clone the repository.

git clone https://github.com/CPNV-ES/MAW11_Mugiwaras_Framework

2. install the dependencies with composer

composer install

3. copy the .env.example or set the required environment variables.

4. You are all set! You can now work with the framework.

Credits

The section system of the framework is greatly inspired from devanych vue-renderer which did an amazing work. You can find the repository here