An open API service indexing awesome lists of open source software.

https://github.com/joepdooper/ivy

Yet another sleek simple fast CMS with an effortless template and plugin environment
https://github.com/joepdooper/ivy

bento build clean cms cms-framework content-management-system design easy easy-to-deploy fast google-page-speed grid model-view-controller mvc mvc-pattern quick simple slim web-app web-application-framework

Last synced: about 1 month ago
JSON representation

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

Awesome Lists containing this project

README

          

# ivy

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

[![Composer](https://img.shields.io/badge/Composer-222)](https://getcomposer.org/)
[![npm](https://img.shields.io/badge/npm-222)](https://www.npmjs.com/)
[![PHP](https://img.shields.io/badge/PHP-v8.4.0-222)](https://www.php.net/)

## Install

#### 1. Navigate to your project folder

Open terminal and navigate to your project folder:

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

#### 2. Download ivy files

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

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

#### 3. Configure

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

#### 4. Setup

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

If you have Docker or Podman run:

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

##### 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:

```bash
mysql -u your_database_username -p your_database_name < docker/mysql/ivy.sql
```

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.

## Login

#### Accessing the backend

To access the "backend" for the first time, after the installation, follow these steps:

1. Navigate to `yourserver.com/admin/login` (user icon)
2. Use the credentials `admin@localhost.test` and `00000`
3. Upon successful login, you will be directed to the profile page with *super_admin* rights

#### Changing email and password

Open the `.env` file and update it with your mailbox credentials. If you've modified the `.env` file, follow these steps:

1. Upon login, on the profile page, modify and submit your email address to initiate the email change process
2. After successfully changing your email address, go to `yourserver.com/admin/logout` to log out (logout icon)
3. Finally, navigate to `yourserver.com/admin/reset` to initiate the password reset process

## Documentation

[Documentation](https://ivy.dooper.io) coming up