Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/khodakhah/nodcms

NodCMS-Bundle - to download - the open-source PHP CMS based on the CodeIgniter
https://github.com/khodakhah/nodcms

cms codeigniter4 mit-license modular-design php

Last synced: 24 days ago
JSON representation

NodCMS-Bundle - to download - the open-source PHP CMS based on the CodeIgniter

Awesome Lists containing this project

README

        

# [NodCMS](http://nodcms.com)
NodCMS is a free, Multilingual, simple and powerful CMS based on [CodeIgniter4]((https://codeigniter.com/)).

More information can be found at [nodcms.com](http://nodcms.com/).

This repository holds a source, composer dependencies, and latest released versions of the NodCMS.

## Demo
[demo.nodcms.com](http://demo.nodcms.com/)

Username: `demo`, Password: `demo`

## Download
### git clone
Run ```git clone https://github.com/khodakhah/nodcms.git```

### Composer
#### Create a new NodCMS project

This installation technique would suit a developer who wishes to start a new NodCMS based project.

```
composer create-project khodakhah/nodcms
```
#### Adding NodCMS to an Existing Project
```
composer require khodakhah/nodcms
```
Copy the `public`, `writable`, and all folders with the prefix `nodcms-` from `vendor/khodakhah/nodcms` to your project root

### Traditionally
You can download the latest released version as a ZIP file from [nodcms-bundle](https://github.com/khodakhah/nodcms-bundle).

[Download ZIP File](https://github.com/khodakhah/nodcms-bundle/archive/master.zip)

## Server requirement

Please check this link https://codeigniter.com/user_guide/intro/requirements.html

## Installation

### Local and development
```shell
# Set up local environment and install all dependencies
composer checkout

# Run the project locally
composer start
```

Now you should be able to open the [localhost:8080](http://localhost:8080) in browser.

### Docker
[Install docker compose](https://docs.docker.com/compose/install/) required!
```shell
# Build and run
docker-compose up

# Build and run quietly
docker-compose up -d

# In order to install dependencies without PHP environment checking
composer install --ignore-platform-reqs

# Stop running if you run the 'docker-compose -d'
docker-compose stop
```

Then open the http://localhost:8000 in the browser.

> Database parameters for docker:
> - HOST: `nodcmsdb`
> - PASSWORD: `nodcms`
> - DATABASE: `nodcms`
> - USER: `nodcms`
> - PASSWORD: `nodcms`

## Database setup
NodCMS database structure will be automatically generated form Models.

To build database there is two options.

For both way you need to create your table(an empty table) manually.

### 1. User Interface
NodCMS database structure can be created automatically from models throw a wizard CMS installation.

You need only open the project with a browser and follow the installation steps.
[Learn more](https://nodcms.com/user-guide/)

---

### 2. Command Interface
To setup database and create tables via CLI, you need to run the following commands:
```shell
# 1. Save database connection parameters in .env file
php spark database:setup localhost root db-password table-name

# 2. Create database tables
php spark database:build

# 3. Create/Update an admin user with the given parameters
php spark settings:admin [firstname] [lastname] [email] [password]
```
#### Important
If you already have some tables in your given database, the command `database:build` will not overwrite the existed tables.

To overwrite exists tables you need to add `-overwrite` option on command.
```shell
# Build database overwrite exists tables
php spark database:build -overwrite
```

`php spark settings:admin [firstname] [lastname] [email] [password]` can be used anytime in the future. It will overwrite the admin user if it exists.
_Just in the case that you lose your password, and you want to reset it._

## Bugs Reports
If you find an issue, let me know [here](https://github.com/khodakhah/nodcms/issues/new)!