PHPackages                             neoground/charm - 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. neoground/charm

ActiveLibrary[Framework](/categories/framework)

neoground/charm
===============

Charm Framework

v3.8.4(5mo ago)2846[29 issues](https://github.com/neoground/charm/issues)[2 PRs](https://github.com/neoground/charm/pulls)2MITPHPPHP &gt;=8.3CI passing

Since Mar 27Pushed 3d ago1 watchersCompare

[ Source](https://github.com/neoground/charm)[ Packagist](https://packagist.org/packages/neoground/charm)[ Docs](https://neoground.com/projects/charm)[ Fund](https://www.paypal.com/paypalme/neoground)[ RSS](/packages/neoground-charm/feed)WikiDiscussions master Synced 3d ago

READMEChangelog (10)Dependencies (20)Versions (25)Used By (2)

Charm Framework
===============

[](#charm-framework)

[![Header Banner](https://camo.githubusercontent.com/bcb8f4f399592f229966a43668aed4aa5f1b7da852e4f7f5199f4a896ca31294/68747470733a2f2f6e656f67726f756e642e636f6d2f646174612f70726f6a656374732f636861726d2f6173736574732f62616e6e65722e6a7067)](https://camo.githubusercontent.com/bcb8f4f399592f229966a43668aed4aa5f1b7da852e4f7f5199f4a896ca31294/68747470733a2f2f6e656f67726f756e642e636f6d2f646174612f70726f6a656374732f636861726d2f6173736574732f62616e6e65722e6a7067)

---

[![GitHub release (latest SemVer)](https://camo.githubusercontent.com/bc492b73a42a6b62d19c4dd241005519198dd3caa9e6508e19ec0fe1b95a9774/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f6e656f67726f756e642f636861726d3f736f72743d73656d766572)](https://camo.githubusercontent.com/bc492b73a42a6b62d19c4dd241005519198dd3caa9e6508e19ec0fe1b95a9774/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f6e656f67726f756e642f636861726d3f736f72743d73656d766572)[![GitHub license](https://camo.githubusercontent.com/a41b79985778162ade59d7f241887d43bbad9366c71d6b79abfbef7e5ed72ea3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6e656f67726f756e642f636861726d)](https://camo.githubusercontent.com/a41b79985778162ade59d7f241887d43bbad9366c71d6b79abfbef7e5ed72ea3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6e656f67726f756e642f636861726d)[![Packagist Downloads](https://camo.githubusercontent.com/a5798af6a010322e179c78d9d41f2441e4feef572e64f77b99ede79f0061bbd5/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6e656f67726f756e642f636861726d)](https://camo.githubusercontent.com/a5798af6a010322e179c78d9d41f2441e4feef572e64f77b99ede79f0061bbd5/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6e656f67726f756e642f636861726d)[![GitHub issues](https://camo.githubusercontent.com/a3bd001165344fd27fe86a8ba30201326860b22b21785778c1b54e9c46813c01/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f6e656f67726f756e642f636861726d)](https://camo.githubusercontent.com/a3bd001165344fd27fe86a8ba30201326860b22b21785778c1b54e9c46813c01/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f6e656f67726f756e642f636861726d)[![GitHub stars](https://camo.githubusercontent.com/ecbd2eb251b409338eaed11cecd02227e7d048e2af73d6a5e8be1b0102bfe73c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f6e656f67726f756e642f636861726d3f7374796c653d736f6369616c)](https://camo.githubusercontent.com/ecbd2eb251b409338eaed11cecd02227e7d048e2af73d6a5e8be1b0102bfe73c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f6e656f67726f756e642f636861726d3f7374796c653d736f6369616c)

A performant, modern PHP Framework
----------------------------------

[](#a-performant-modern-php-framework)

A lightweight, fast, modular PHP framework – the foundation for ambitious apps and SaaS. Crafted and used in production by Neoground.

Charm is a **modern PHP framework** optimized for **PHP 8.5**, performance, and clean architecture.
It powers Neoground’s own projects and SaaS products and is designed as a solid, composable foundation for:

- APIs and backends
- SaaS and business applications
- Hybrid/web apps with modern frontends

Version 4 of this framework is a major rewrite with breaking changes. It is our goal to have a solid foundation for all kind of webapps and websites for many years.

Below you find the legacy Readme.

🚀 A Galactic Adventure in PHP Web Development
---------------------------------------------

[](#-a-galactic-adventure-in-php-web-development)

In a galaxy far, far away, there was a PHP web framework that changed the way developers explored the vast universe of web development. The Charm Framework brings balance to the Force, combining power, performance, and a touch of artistry to create an extraordinary tool for your intergalactic adventures in web development.

Programming is not just about writing lines of code; it's an art form that requires creativity, passion, and the courage to explore uncharted territories. With the Charm Framework, you'll embark on an epic journey through the cosmos of web development, discovering new ways to create and innovate while having fun along the way.

We've infused the Charm Framework with the spirit of Sci-Fi, timeless tales of heroes and villains, triumph and tragedy, that has captured the hearts of millions across the galaxy. Our goal is to bring the magic and excitement of this beloved saga to the world of PHP web development, inspiring you to embrace your inner Jedi and become a true master of your craft.

As you delve into the Charm Framework, you'll encounter a rich and diverse ecosystem of tools and features designed to help you build powerful, high-performance web applications that can stand the test of time. With the wisdom of Yoda, the tenacity of Luke Skywalker, and the grace of Princess Leia, the Charm Framework will guide you on your path to web development mastery.

So strap in, grab your lightsaber, and prepare to embark on an unforgettable journey through the world of PHP web development. Together, we'll conquer even the most daunting coding challenges, unlocking the full potential of the Charm Framework and paving the way for a brighter future in the galaxy of web development.

May the Force be with you, always.

🌐 About
-------

[](#-about)

Charm is a blazing-fast PHP framework optimized for building business web applications and APIs. With its lightweight design and fast router, Charm is optimized for high-performance, making it a powerful tool for developers who need to build applications that can handle heavy loads with ease.

Charm provides its own Twig views, but it can also easily be used with a single-page JS app. The framework is built using a combination of popular libraries and slim, optimized solutions, including the Eloquent ORM for database tasks, Redis caching for high performance, and a built-in user and auth system.

Charm also includes many convenience functionalities without overloading it, such as Cron and Queue systems for scheduling tasks, and a great debugging help with Kint, Whoops, and Debugbar. All app init data can be stored in a single file to increase boot up even more, and config files are in YAML. Modules and own packages based on this framework are easily possible and integrated into other projects in seconds.

But Charm is more than just a fast and powerful PHP framework. We've designed our documentation to be engaging and enjoyable to read. We believe that learning a new technology should be a fun and rewarding experience, and our documentation reflects that commitment to making the learning process as enjoyable as possible.

Whether you're a seasoned developer or just getting started with PHP, Charm is the perfect tool for building high-performance web applications and APIs. With its slim, optimized design and powerful features, Charm is the ideal choice for developers who want to build fast, scalable, and maintainable applications with ease.

🎉 Getting Started
-----------------

[](#-getting-started)

Please see our [official documentation](https://neoground.com/docs/charm/index)and its included [Getting Started Guide](https://neoground.com/docs/charm/start.installation).

### Requirements: Fuel for Your Galactic Adventure

[](#requirements-fuel-for-your-galactic-adventure)

To ensure a smooth journey with the Charm Framework, make sure your system meets the following requirements:

- PHP 8.3 or later (ideally with Redis module)
    - PHP installation needs basic extensions. Make sure you don't have "php-psr" installed, since this conflicts with Monolog's Logging engine.
- Composer
- Depending on your app:
    - Database: MariaDB, MySQL, SQLite, PostgreSQL or SQL Server
    - Redis

### Installation: As Easy as the Kessel Run

[](#installation-as-easy-as-the-kessel-run)

To install the Charm Framework, you first need to install Bob toolkit on your machine.

In a galaxy not so far away, Bob (short for Binary Operations Butler) was created to serve as the ultimate command-line companion for Charm Framework developers.

Run the following command to install Bob:

```
curl -fSsL -o bob https://raw.githubusercontent.com/neoground/charm-toolkit/main/bob && chmod +x bob
sudo mv bob /usr/local/bin/bob
```

For more information on this, see the [Bob documentation](https://github.com/neoground/charm-toolkit).

Once installed, run the following command to create a new project:

```
bob new GalacticArchive
```

This command will generate a new project called `GalacticArchive` based on the [charm-wireframe](https://github.com/neoground/charm-wireframe)template and put it in the new created directory `GalacticArchive`. The wireframe serves as a foundation for all Charm Framework applications, empowering you to build incredible web applications in the universe.

The setup assistant then guides you through the process.

### Configuration: Fine-Tuning the Hyperdrive

[](#configuration-fine-tuning-the-hyperdrive)

Now that your project is set up, you can check and adjust the global configuration by navigating to the `app/Config` directory. For environment-specific settings, explore the `app/Config/Environments/Local` directory.

The active environment is determined by the `app/app.env` file, which contains the name of the environment in use, e.g. `ENVIRONMENT=Prod`. The auto setup process takes care of this for you.

### Web Server Setup: Powering Up the Millennium Falcon

[](#web-server-setup-powering-up-the-millennium-falcon)

To get your web server up and running, you might need to adjust its configuration. The charm-wireframe comes with a sample `.htaccess` and `nginx.conf` file to help you get started.

For a local development server, simply type `bob serve` in the project directory, and you'll be good to go!

May the Force guide you, young Jedi!

🚧 Beta Notice
-------------

[](#-beta-notice)

Please note that Charm is currently in beta. We are hard at work on version 4.0, which will be the first full stable release.

Starting at version 3.7, charm is in a stable beta. We didn't experience bigger bugs in the last few months, and it runs very well on our production apps. Huge, breaking changes are unlikely from now on.

☕ Support Charm's Development
-----------------------------

[](#-support-charms-development)

We're committed to making Charm the best PHP framework out there, and we could use your help! By becoming a sponsor or making a donation, you can help us accelerate the development process and bring Charm 4.0 to life. Your support allows us to dedicate more time and resources to the project, ensuring that Charm continues to evolve and improve.

To make a donation or become a sponsor, check out our [official documentation](https://neoground.com/docs/charm/index). Thank you for your support and for helping us make Charm even better!

###  Health Score

45

—

FairBetter than 92% of packages

Maintenance66

Regular maintenance activity

Popularity19

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity69

Established project with proven stability

 Bus Factor1

Top contributor holds 99.7% 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 ~48 days

Recently: every ~5 days

Total

21

Last Release

173d ago

PHP version history (2 changes)3.0PHP &gt;=8.1

v3.7PHP &gt;=8.3

### Community

Maintainers

![](https://www.gravatar.com/avatar/850bdca3f343de32a480cf9e35f2aa14e33cfbfcfc2710780203bd7807cd677b?d=identicon)[neoground](/maintainers/neoground)

---

Top Contributors

[![neoground](https://avatars.githubusercontent.com/u/9088619?v=4)](https://github.com/neoground "neoground (654 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (2 commits)")

---

Tags

charm-frameworkframeworkphp

### Embed Badge

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

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

###  Alternatives

[laravel/framework

The Laravel Framework.

34.6k509.9M17.0k](/packages/laravel-framework)[shopware/platform

The Shopware e-commerce core

3.3k1.5M3](/packages/shopware-platform)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

595.2M386](/packages/shopware-core)[sulu/sulu

Core framework that implements the functionality of the Sulu content management system

1.3k1.3M152](/packages/sulu-sulu)[concrete5/core

Concrete core subtree split

19159.3k48](/packages/concrete5-core)[contao/core-bundle

Contao Open Source CMS

1231.6M2.4k](/packages/contao-core-bundle)

PHPackages © 2026

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