PHPackages                             joepdooper/ivy - 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. joepdooper/ivy

ActiveProject[Framework](/categories/framework)

joepdooper/ivy
==============

Yet another sleek simple fast CMS with an effortless template and plugin environment

v0.9.9-alpha(4mo ago)124MITPHPPHP >=8.4.0CI passing

Since Dec 21Pushed 1mo ago1 watchersCompare

[ Source](https://github.com/joepdooper/ivy)[ Packagist](https://packagist.org/packages/joepdooper/ivy)[ RSS](/packages/joepdooper-ivy/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (5)Versions (4)Used By (0)

ivy
===

[](#ivy)

Yet another sleek simple fast CMS with an effortless template and plugin environment

[![Composer](https://camo.githubusercontent.com/34ec1b450e28ae2fed3d085c2fd8a47435db14d308d0c091d9c6408548003cde/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f436f6d706f7365722d323232)](https://getcomposer.org/)[![npm](https://camo.githubusercontent.com/c46b3b762eaf94a3c0c0243884e1fc0cb47ff4deedb0cba9df78c1e0efde69e1/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6e706d2d323232)](https://www.npmjs.com/)[![PHP](https://camo.githubusercontent.com/9780b09906b06ff751f87a2b55b1bdfb3a7ed37718b08e50b11d12c112833155/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d76382e342e302d323232)](https://www.php.net/)

Install
-------

[](#install)

#### 1. Navigate to your project folder

[](#1-navigate-to-your-project-folder)

Open terminal and navigate to your project folder:

```
cd path/to/your/ivy/project
```

#### 2. Download ivy files

[](#2-download-ivy-files)

Use [Composer](https://getcomposer.org/) to create a new project with **ivy**:

```
composer create-project joepdooper/ivy .
```

#### 3. Configure

[](#3-configure)

Rename the `example.env` file to `.env`.

If you are not using the provided Docker or Podman compose files, update the .env file with your database credentials and make sure your web server points to the `public/` folder inside this project [`000-default.conf`](docker/sites-available/000-default.conf). Additionally, ensure that the `public/` and `cache/` folders have the proper permissions so your web server can read and write to them as needed.

#### 4. Setup

[](#4-setup)

##### Option A - Start the containers (recommended)

[](#option-a---start-the-containers-recommended)

If you have Docker or Podman run:

```
./vendor/bin/cultivate
```

##### Option B - Start webserver and set up the database

[](#option-b---start-webserver-and-set-up-the-database)

Create a database for **ivy** and import the provided [`ivy.sql`](docker/mysql/ivy.sql) file:

```
mysql -u your_database_username -p your_database_name