PHPackages                             roolith/framework - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. roolith/framework

ActiveProject[Framework](/categories/framework)

roolith/framework
=================

Roolith PHP framework

3.0.0(7mo ago)2251MITPHPPHP >=8.0

Since Sep 2Pushed 7mo ago2 watchersCompare

[ Source](https://github.com/im4aLL/roolith-framework)[ Packagist](https://packagist.org/packages/roolith/framework)[ RSS](/packages/roolith-framework/feed)WikiDiscussions master Synced 6d ago

READMEChangelogDependencies (9)Versions (13)Used By (0)

roolith-framework
=================

[](#roolith-framework)

Roolith PHP framework. Very minimalistic and less overhead.

### Install

[](#install)

```
composer create-project roolith/framework your_app_name

```

### Documentation

[](#documentation)

- Cache [documentation](https://github.com/im4aLL/roolith-cache)
- Config [documentation](https://github.com/im4aLL/roolith-config)
- Database [documentation](https://github.com/im4aLL/roolith-database)
- Event [documentation](https://github.com/im4aLL/roolith-event)
- Generator [documentation](https://github.com/im4aLL/roolith-generator)
- Router [documentation](https://github.com/im4aLL/roolith-router)
- Template-engine [documentation](https://github.com/im4aLL/roolith-template-engine)

> If you want to use this or need any help, you may reach to `me@habibhadi.com`This framework has been developed for educational purpose!

### Generator

[](#generator)

```
php roolith generate controller DemoController
php roolith generate model Product
php roolith generate middleware AuthMiddleware

```

### Define route

[](#define-route)

Open `app/Http/routes.php` and define routes as per [documentation](https://github.com/im4aLL/roolith-router)

### Error page

[](#error-page)

If there is no route defined then by default it will look for `404.php` in `viwes` folder.

### Config

[](#config)

All application configuration has been stored on `config/config.php` for more details read [documentation](https://github.com/im4aLL/roolith-config)

### Constant

[](#constant)

Application constants has been defined into `/constant.php`

### Frontend workflow

[](#frontend-workflow)

```
npm install

```

Then

```
npm start

```

> Before npm start open the gulpfile.js update browsersync options as per your need. Specially change vhost defined `local.roolith-framework.me`

To add SCSS and JS use `source/scss/app.scss` and `source/js/app.js`

Use

```
npm run build

```

for production build. It will create min.css and min.js file.

### Model

[](#model)

Model files located into `app/Models`

```