{"id":19776890,"url":"https://github.com/neoground/charm","last_synced_at":"2025-04-30T19:31:10.790Z","repository":{"id":32459221,"uuid":"133713844","full_name":"neoground/charm","owner":"neoground","description":"Experience Charm, a blazing-fast PHP 8 framework tailored for high-performance web apps \u0026 APIs. Unleash your business potential with this sleek, lightweight powerhouse. Level up your development!","archived":false,"fork":false,"pushed_at":"2025-04-24T12:19:10.000Z","size":903,"stargazers_count":2,"open_issues_count":26,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-24T13:28:35.032Z","etag":null,"topics":["charm-framework","framework","php"],"latest_commit_sha":null,"homepage":"https://neoground.com/projects/charm","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/neoground.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":["https://www.paypal.com/paypalme/neoground"]}},"created_at":"2018-05-16T19:28:20.000Z","updated_at":"2025-04-24T12:19:14.000Z","dependencies_parsed_at":"2023-11-25T15:21:15.341Z","dependency_job_id":"48f203db-bcfb-4e7f-a109-2bff2d584ba9","html_url":"https://github.com/neoground/charm","commit_stats":{"total_commits":413,"total_committers":2,"mean_commits":206.5,"dds":0.002421307506053294,"last_synced_commit":"31b1de0332ef96ad1c3de4e5f7341aa9f43bf829"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neoground%2Fcharm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neoground%2Fcharm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neoground%2Fcharm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neoground%2Fcharm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/neoground","download_url":"https://codeload.github.com/neoground/charm/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251769294,"owners_count":21640881,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["charm-framework","framework","php"],"created_at":"2024-11-12T05:22:15.022Z","updated_at":"2025-04-30T19:31:10.784Z","avatar_url":"https://github.com/neoground.png","language":"PHP","funding_links":["https://www.paypal.com/paypalme/neoground"],"categories":[],"sub_categories":[],"readme":"# Charm Framework\n\n![Header Banner](https://neoground.com/data/projects/charm/assets/banner.jpg)\n\n---\n\n![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/neoground/charm?sort=semver)\n![GitHub license](https://img.shields.io/github/license/neoground/charm)\n![Packagist Downloads](https://img.shields.io/packagist/dt/neoground/charm)\n![GitHub issues](https://img.shields.io/github/issues/neoground/charm)\n![GitHub stars](https://img.shields.io/github/stars/neoground/charm?style=social)\n\n## 🚀 A Galactic Adventure in PHP Web Development\n\nIn a galaxy far, far away, there was a PHP web framework that \nchanged the way developers explored the vast universe of web development.\nThe Charm Framework brings balance to the Force, combining power, performance, \nand a touch of artistry to create an extraordinary tool for your \nintergalactic adventures in web development.\n\nProgramming is not just about writing lines of code; it's an art form that \nrequires creativity, passion, and the courage to explore uncharted territories. \nWith the Charm Framework, you'll embark on an epic journey through the cosmos of \nweb development, discovering new ways to create and innovate while having fun along the way.\n\nWe've infused the Charm Framework with the spirit of Sci-Fi, timeless tales of \nheroes and villains, triumph and tragedy, that has captured the hearts of millions across the galaxy. \nOur goal is to bring the magic and excitement of this beloved saga to the world of PHP web development, \ninspiring you to embrace your inner Jedi and become a true master of your craft.\n\nAs you delve into the Charm Framework, \nyou'll encounter a rich and diverse ecosystem of tools and features designed to help you build powerful, \nhigh-performance web applications that can stand the test of time. With the wisdom of Yoda, \nthe tenacity of Luke Skywalker, and the grace of Princess Leia, \nthe Charm Framework will guide you on your path to web development mastery.\n\nSo strap in, grab your lightsaber, and prepare to embark on an unforgettable \njourney through the world of PHP web development. Together, we'll conquer even the most daunting \ncoding challenges, unlocking the full potential of the Charm Framework and paving the way \nfor a brighter future in the galaxy of web development.\n\nMay the Force be with you, always.\n\n\n## 🌐 About\n\nCharm is a blazing-fast PHP framework optimized for building business web \napplications and APIs. With its lightweight design and fast router, \nCharm is optimized for high-performance, making it a powerful tool for \ndevelopers who need to build applications that can handle heavy loads with ease.\n\nCharm provides its own Twig views, but it can also easily be used with a \nsingle-page JS app. The framework is built using a combination of popular libraries \nand slim, optimized solutions, including the Eloquent ORM for database tasks, \nRedis caching for high performance, and a built-in user and auth system.\n\nCharm also includes many convenience functionalities without overloading it, \nsuch as Cron and Queue systems for scheduling tasks, and a great debugging help with Kint,\nWhoops, and Debugbar. All app init data can be stored in a single file to increase boot \nup even more, and config files are in YAML. Modules and own packages based on this \nframework are easily possible and integrated into other projects in seconds.\n\nBut Charm is more than just a fast and powerful PHP framework. We've designed our \ndocumentation to be engaging and enjoyable to read. \nWe believe that learning a new technology \nshould be a fun and rewarding experience, and our documentation reflects that \ncommitment to making the learning process as enjoyable as possible.\n\nWhether you're a seasoned developer or just getting started with PHP, \nCharm is the perfect tool for building high-performance web applications and APIs. \nWith its slim, optimized design and powerful features, \nCharm is the ideal choice for developers who want to build fast, \nscalable, and maintainable applications with ease.\n\n\n##  🎉 Getting Started\n\nPlease see our [official documentation](https://neoground.com/docs/charm/index)\nand its included [Getting Started Guide](https://neoground.com/docs/charm/start.installation).\n\n### Requirements: Fuel for Your Galactic Adventure\n\nTo ensure a smooth journey with the Charm Framework, make sure your system meets the following requirements:\n\n- PHP 8.3 or later (ideally with Redis module)\n- Composer\n- Depending on your app:\n    - Database: MariaDB, MySQL, SQLite, PostgreSQL or SQL Server\n    - Redis\n\n### Installation: As Easy as the Kessel Run\n\nTo install the Charm Framework, you first need to install Bob toolkit on your machine.\n\nIn a galaxy not so far away, Bob (short for Binary Operations Butler) was created\nto serve as the ultimate command-line companion for Charm Framework developers.\n\nRun the following command to install Bob:\n\n```bash\ncurl -fSsL -o bob https://raw.githubusercontent.com/neoground/charm-toolkit/main/bob \u0026\u0026 chmod +x bob\nsudo mv bob /usr/local/bin/bob\n```\n\nFor more information on this, see the [Bob documentation](https://github.com/neoground/charm-toolkit).\n\nOnce installed, run the following command to create a new project:\n\n```bash\nbob new GalacticArchive\n```\n\nThis command will generate a new project called `GalacticArchive` based on the [charm-wireframe](https://github.com/neoground/charm-wireframe)\ntemplate and put it in the new created directory `GalacticArchive`. The wireframe serves as\na foundation for all Charm Framework applications, empowering you to build incredible\nweb applications in the universe.\n\nThe setup assistant then guides you through the process.\n\n### Configuration: Fine-Tuning the Hyperdrive\n\nNow that your project is set up, you can check and adjust the global configuration\nby navigating to the `app/Config` directory. For environment-specific settings,\nexplore the `app/Config/Environments/Local` directory.\n\nThe active environment is determined by the `app/app.env` file, which contains\nthe name of the environment in use, e.g. `ENVIRONMENT=Prod`. The auto setup process takes care of this for you.\n\n### Web Server Setup: Powering Up the Millennium Falcon\n\nTo get your web server up and running, you might need to adjust its configuration.\nThe charm-wireframe comes with a sample `.htaccess` and `nginx.conf` file to help you get started.\n\nFor a local development server, simply type `bob serve` in the project directory, and you'll be good to go!\n\nMay the Force guide you, young Jedi!\n\n\n## 🚧 Beta Notice\n\nPlease note that Charm is currently in beta.\nWe are hard at work on version 4.0, which will be the first full stable release. \n\nStarting at version 3.7, charm is in a stable beta. We didn't experience bigger bugs in the\nlast few months, and it runs very well on our production apps. Huge, breaking changes are unlikely from now on.\n\n## ☕ Support Charm's Development\n\nWe're committed to making Charm the best PHP framework out there, \nand we could use your help! By becoming a sponsor or making a donation, \nyou can help us accelerate the development process and bring Charm 4.0 to life. \nYour support allows us to dedicate more time and resources to the project, \nensuring that Charm continues to evolve and improve.\n\nTo make a donation or become a sponsor, check out our [official documentation](https://neoground.com/docs/charm/index).\nThank you for your support and for helping us make Charm even better!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneoground%2Fcharm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fneoground%2Fcharm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneoground%2Fcharm/lists"}