PHPackages                             modulusphp/modulusphp - 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. modulusphp/modulusphp

AbandonedArchivedProject[Framework](/categories/framework)

modulusphp/modulusphp
=====================

A cool API Framework for PHP

1.9.9.5(6y ago)791MITPHPPHP &gt;=7.3.0

Since May 5Pushed 6y ago2 watchersCompare

[ Source](https://github.com/modulusphp/modulusphp)[ Packagist](https://packagist.org/packages/modulusphp/modulusphp)[ RSS](/packages/modulusphp-modulusphp/feed)WikiDiscussions 2.0 Synced 5d ago

READMEChangelog (10)Dependencies (1)Versions (36)Used By (0)

[![](https://raw.githubusercontent.com/modulusphp/icons/master/assets/banner-template.png)](https://raw.githubusercontent.com/modulusphp/icons/master/assets/banner-template.png)

[![Total Downloads](https://camo.githubusercontent.com/825b22d685ce256aa15983c21dcca1b809d140c7f5b7e2a0bd96af230298d651/68747470733a2f2f706f7365722e707567782e6f72672f6d6f64756c75737068702f6672616d65776f726b2f642f746f74616c2e737667)](https://packagist.org/packages/modulusphp/framework)[![Latest Stable Version](https://camo.githubusercontent.com/e2d43440b41bc8f3fd3c751f447f028f32f3eca9a5c8b9ff0f0636b9b18a59cb/68747470733a2f2f706f7365722e707567782e6f72672f6d6f64756c75737068702f6672616d65776f726b2f762f737461626c652e737667)](https://packagist.org/packages/modulusphp/framework)[![License](https://camo.githubusercontent.com/b40dddae8c1ef23bc44f19c54f4e9c553563ea95e479be5f106761e4642aac84/68747470733a2f2f706f7365722e707567782e6f72672f6d6f64756c75737068702f6672616d65776f726b2f6c6963656e73652e737667)](https://packagist.org/packages/modulusphp/framework)

Getting Starterd
----------------

[](#getting-starterd)

### Create a new Modulus application

[](#create-a-new-modulus-application)

To create a new Modulus application, we need to run the following command.

```
composer create-project modulusphp/modulusphp application-name

```

> `` is the name of your application. e.g. `blog`

*I assume, you already have composer installed, if not. Check out this link *

Setting up the environment
--------------------------

[](#setting-up-the-environment)

Rename `.env.example` to `.env`

```
# Application
APP_NAME=Modulus
APP_ENV=local
APP_DEBUG=true
APP_URL=http://localhost

# Bugsnag
BUGSNAG_API_KEY=

# Database
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=modulus
DB_USERNAME=root
DB_PASSWORD=secret

# Mail
MAIL_USERNAME=example@domain.com
MAIL_PASSWORD=secret
MAIL_FROM_NAME=foo
MAIL_HOST=smtp.domain.com
MAIL_PORT=465 # or 587
MAIL_SMTP_SECURE=ssl # or tls

# Queues
QUEUE_CONNECTION='queue'
QUEUE_DUMP="framework/data/.queues"

```

Getting the application ready
-----------------------------

[](#getting-the-application-ready)

### Node.js NPM (optional)

[](#nodejs-npm-optional)

Make sure you have nodejs and npm installed then install the dependencies using `npm install`.

But before running the `npm install` command, you might want to change the current frontend framework. The default frontend framework is `react`. You can easily change it by running `php craftsman frontend:switch`.

*If you don't have node.js, follow this tutorial: *

### Migrations (optional)

[](#migrations-optional)

This part is optional (but recommended). The following command will create a couple of tables to get your application ready. (You will be able to edit these tables at a later stage if you want to make any changes).

```
php craftsman migrate all

```

*This will create a users, password\_resets, verified\_users, magic\_links and migrations table*

> Make sure, you have set the **"DB\_DATABASE"**, **"DB\_USERNAME"** and the **"DB\_PASSWORD"** in the .env before running the `migrate all` command.

### Seeders (optional)

[](#seeders-optional)

Craftsman makes it easy to add testing (fake) data into your application database. You can do this by creating a new seed. You can run `php craftsman craft:seeder  --table=""` to create a new seed.

e.g `php craftsman craft:seeder users --table="users"`

And you can run this seed, using the following command `php craftsman seed users --count=10`

The `--count=` represents the number of rows, the seed will add.

*Please note, your application already has the "users" seed.*

> Make sure, you have set the **"DB\_DATABASE"**, **"DB\_USERNAME"** and the **"DB\_PASSWORD"** in the .env before running the seeder.

Running the application
-----------------------

[](#running-the-application)

Run the following command to boot up your Application.

```
php craftsman serve

```

If port `8000` is already in use, just set your own port. e.g

```
php craftsman serve --port=8001

```

*You can now visit your Application on `http://localhost:`*

That's all!

> Author: Donald Pakkies

###  Health Score

32

—

LowBetter than 72% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity15

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity70

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~19 days

Recently: every ~46 days

Total

30

Last Release

2382d ago

Major Versions

1.9.9.5 → 2.0.x-dev2019-11-07

PHP version history (2 changes)1.2PHP &gt;=7.0.0

1.9.1PHP &gt;=7.3.0

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/6256291?v=4)[Donald Pakkies](/maintainers/Donaldp)[@donaldp](https://github.com/donaldp)

---

Top Contributors

[![donaldp](https://avatars.githubusercontent.com/u/6256291?v=4)](https://github.com/donaldp "donaldp (207 commits)")

---

Tags

cmodulusmodulusmvcphpreactvuephpapiframeworkmodulusmodulusphp

### Embed Badge

![Health badge](/badges/modulusphp-modulusphp/health.svg)

```
[![Health](https://phpackages.com/badges/modulusphp-modulusphp/health.svg)](https://phpackages.com/packages/modulusphp-modulusphp)
```

###  Alternatives

[digitalstars/simplevk

Powerful PHP library/framework for VK API bots, supporting LongPoll &amp; Callback &amp; OAuth

883.9k3](/packages/digitalstars-simplevk)[patricksavalle/slim-rest-api

Production-grade REST-API App-class for PHP SLIM, in production on https://zaplog.pro (https://api.zaplog.pro/v1)

101.4k](/packages/patricksavalle-slim-rest-api)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
