PHPackages heyblackmagic/foundation - 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. heyblackmagic/foundation ActiveProject[Framework](/categories/framework) heyblackmagic/foundation ======================== 3.3.1(1y ago)125PHP Since Sep 11Pushed 1y ago1 watchersCompare [ Source](https://github.com/wearealloy/foundation)[ Packagist](https://packagist.org/packages/heyblackmagic/foundation)[ RSS](/packages/heyblackmagic-foundation/feed)WikiDiscussions main Synced 3w ago READMEChangelog (7)Dependencies (13)Versions (8)Used By (0) Craft CMS 5: Foundation ======================= [](#craft-cms-5-foundation) Foundation is a starter project built to streamline development with Craft CMS 5. It serves as a flexible and robust foundation, providing essential configurations, templates, and tools to kickstart your Craft CMS projects efficiently. Whether you're building a simple website or a complex application, this base project aims to save time and ensure best practices are followed from the start. Features: --------- [](#features) - Pre-configured Craft CMS 5 setup. - Customizable templates and components. - Ready-to-use development environment setup. Requirements: ------------- [](#requirements) Before installing this repository, **ensure that the following tools are installed and properly configured**: - Docker: You only need one Docker provider installed. We recommend using [OrbStack](https://orbstack.dev/), but other options like [Lima](https://github.com/lima-vm/lima), [Docker Desktop](https://www.docker.com/products/docker-desktop/), [Rancher Desktop](https://rancherdesktop.io/), or [Colima](https://github.com/abiosoft/colima) are also compatible. **[Follow the recommended settings](https://ddev.readthedocs.io/en/stable/users/install/docker-installation/#macos)**. - [DDEV](https://ddev.readthedocs.io/en/stable/users/install/ddev-installation/#macos). - [Visual Studio Code](https://code.visualstudio.com/). - [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). DDEV global setup ----------------- [](#ddev-global-setup) After installing DDEV, or before installing this repository, **it is highly recommended to configure your current git settings in DDEV**. Run the following command: ``` ln -s ~/.gitconfig ~/.ddev/homeadditions/.gitconfig ``` Installation: ------------- [](#installation) There are two cases where you might need to install this repo: - [Creating a project from scratch](#installing-from-scratch). - [Setting up an existing project via `git pull`](#installing-existing-project-from-git-pull). ### Installing from scratch: [](#installing-from-scratch) 1. Create project with [Composer's](https://getcomposer.org/) `create-project` command: ``` # Create a project directory and move into it: mkdir my-craft-site && cd my-craft-site # Set up the DDEV environment: ddev config --project-type=craftcms --docroot=public_html # Boot the project and install the starter project: ddev start ddev composer create --no-scripts heyblackmagic/foundation ``` 2. Set the project name and any other [DDEV config options](https://ddev.readthedocs.io/en/stable/users/configuration/config/). ``` # Replace YOUR_PROJECT_NAME with the name of your project. ddev config --project-name=YOUR_PROJECT_NAME # Restart DDEV ddev restart ``` 3. Install Craft CMS. **IMPORTANT:** During the installation, the Craft CLI will prompt for information such as database credentials (name, password, user, and database driver) or the project URL. These values are pre-configured and should not be edited. ``` ddev craft install # or ddev craft install \ --username="YOUR_USERNAME" \ --email="YOUR_EMAIL@DOMAIN.COM" \ --password="YOUR_PASSWORD" \ --site-url='$DDEV_PRIMARY_URL' ``` 4. Open project with VSCode. ``` ddev code ``` **It’s possible that VSCode will ask if you want to install the recommended extensions for this repository.** [![VSCode recommended extensions notification](/.vscode/vscode-recommended-prompt.png)](/.vscode/vscode-recommended-prompt.png) We highly recommend installing the suggested extensions. [You can see a full list of recommended extensions here.](#vscode-extensions) If VSCode doesn’t prompt you about the recommended extensions, you can check them manually by going to Extensions (shift + command + X). In the search bar, filter by “Recommended.” [![VSCode extensions panel](/.vscode/vscode-filter-recommended.png)](/.vscode/vscode-filter-recommended.png) --- At this point, running `ddev launch` or `ddev launch /admin` will open your project's URL in the default browser. Happy coding! 😊 ### Installing existing project (from `git pull`): [](#installing-existing-project-from-git-pull) If you are installing an existing project from a `git pull` or `git clone`, follow these steps. 1. Pull or clone the project from GitHub. 2. To avoid discrepancies between environments when working collaboratively, avoid changing the name of the DDEV project. Any changes you make to the repo configuration should be communicated to your team. 3. Boot the project. ``` ddev start ``` 4. Import project db. ``` ddev craft db/restore ./YOUR_DB_BACKUP_PATH ``` 5. Open project with VSCode. ``` ddev code ``` **It’s possible that VSCode will ask if you want to install the recommended extensions for this repository.** [![VSCode recommended extensions notification](/.vscode/vscode-recommended-prompt.png)](/.vscode/vscode-recommended-prompt.png) We highly recommend installing the suggested extensions. [You can see a full list of recommended extensions here.](#vscode-extensions) If VSCode doesn’t prompt you about the recommended extensions, you can check them manually by going to Extensions (shift + command + X). In the search bar, filter by “Recommended.” [![VSCode extensions panel](/.vscode/vscode-filter-recommended.png)](/.vscode/vscode-filter-recommended.png) --- You’re ready to continue developing on your existing project. Happy coding! Resolving ambiguities about commands ------------------------------------ [](#resolving-ambiguities-about-commands) In order for DDEV to be able to execute the commands in their respective context, you must prefix each command with ddev. For example, instead of typing npm run dev, you should type ddev npm run dev. Ref: [FAQS, DDEV docs](https://ddev.readthedocs.io/en/stable/users/usage/faq/#why-do-i-have-to-type-ddev-in-front-of-so-many-commands). However, when you run the `ddev code` command, VSCode opens the project with the Dev Containers extension, i.e. it opens the docker container directly. This means that any actions in the project will be in the docker / DDEV context, so if you open a VSCode terminal, you won't need the `ddev` prefix when running your commands. Workflow commands ----------------- [](#workflow-commands) - `ddev npm run dev`: Start Vite development server. - `ddev npm run build`: Compile JS and CSS with Vite. - `ddev craft`: Craft console app. VSCode Extensions ----------------- [](#vscode-extensions) We strongly recommend installing the following extensions for a better development experience: - [DEV Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers): The Dev Containers extension lets you use a Docker container as a full-featured development environment. - [EditorConfig for VSCode](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig): This plugin attempts to override user/workspace settings with settings found in .editorconfig files. - [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode): Prettier is an opinionated code formatter. It enforces a consistent style by parsing your code and re-printing it with its own rules that take the maximum line length into account, wrapping code when necessary. - [Tailwind CSS IntelliSense](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss): Tailwind CSS IntelliSense enhances the Tailwind development experience by providing Visual Studio Code users with advanced features such as autocomplete, syntax highlighting, and linting. - [Twiggy](https://marketplace.visualstudio.com/items?itemName=moetelo.twiggy): Twiggy Language Server provides syntax highlighting, autocompletion, and formatting for Twig. It is recommended to uninstall any other Twig extensions. ### Health Score 28 — LowBetter than 52% of packages Maintenance46 Moderate activity, may be stable Popularity8 Limited adoption so far Community7 Small or concentrated contributor base Maturity44 Maturing project, gaining track record 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 ~40 days Recently: every ~58 days Total 7 Last Release 410d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/aa8eeba0adbebac6380d2dcc14235fa5166da22f8389cadd667f7cfcbc410636?d=identicon)[heyblackmagic](/maintainers/heyblackmagic) --- Top Contributors [![anuarhdz](https://avatars.githubusercontent.com/u/37639437?v=4)](https://github.com/anuarhdz "anuarhdz (28 commits)") ### Embed Badge ![Health badge](/badges/heyblackmagic-foundation/health.svg) ``` [![Health](https://phpackages.com/badges/heyblackmagic-foundation/health.svg)](https://phpackages.com/packages/heyblackmagic-foundation) ``` ### Alternatives [tempest/framework The PHP framework that gets out of your way. 2.2k31.1k12](/packages/tempest-framework)[verbb/formie The most user-friendly forms plugin for Craft. 100387.6k57](/packages/verbb-formie)[solspace/craft-freeform The most flexible and user-friendly form building plugin! 53675.5k15](/packages/solspace-craft-freeform)[lion/bundle Lion-framework configuration and initialization package 122.3k3](/packages/lion-bundle)[aedart/athenaeum Athenaeum is a mono repository; a collection of various PHP packages 245.2k](/packages/aedart-athenaeum) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)