/chimera-cms

Content Management System Based on chimera-framework

Primary LanguageJavaScript

Chimera CMS

Prerequisites

Before run the application, you need to make sure you have following softwares installed in your computer:

  • Node.Js + npm
  • Mongodb

Installation

Using chimera-init-cms

  • Ensure you have Chimera-framework installed as global. You can install chimera-framework by invoking npm install --global chimera-framework
  • Ensure you have git installed. You can install git by invoking apt-get install git
  • Invoke chimera-init-cms <your-project-name>
  • Start the server from inside <your-project-name> directory 
    cd <your-project-name>
npm start

Using git clone

  • Ensure you have git installed. You can install git by invoking apt-get install git
  • Invoke git clone git@github.com:goFrendiAsgard/chimera-cms.git
  • Do migration and start the server from inside chimera-cms directory 
    cd chimera-cms
npm run-script migrate up
npm start

Commonly used command

  • Run migration by invoking npm run-script migrate
  • Start the server by invoking npm start

Quick Reference

Run Migration

  • Invoke npm run-script migrate up or npm run-script migrate to upgrade
  • Invoke npm run-script migrate down to downgrade
  • Invoke npm run-script migrate up [version] to upgrade to certain [version]
  • Invoke npm run-script migrate down [version] to downgrade to certain [version]

Run Server

  • Invoke npm start
  • Or invoke node index.js

Testing

  • Run migration (npm run-script migrate up)
  • When prompted for superAdmin's username and password, please type admin and admin
  • Run the test (npm test)

Docker

Run docker containers

  • Install chimera-cms (refer to the installation guide)
  • Ensure you have docker and docker-compose installed. You can compose those docker images by invoking sudo apt-get install docker docker-compose
  • Perform docker-compose up

Migration

  • Run docker container ls to see list of containers, take note for either CONTAINER ID or NAMES
  • Run docker exec -it <container-id-or-name> bash, where <container-id-or-name> is either container id or container name of chimeracms_cms
  • Run node migrate.js

Stop docker containers

  • Perform docker-compose down

Possible solutions (if something doesn't work)

Change connection string

  • Run docker inspect mongo, take note the IPAddress
  • Run docker exec -it <cms-container-id-or-name> bash
  • Run vim webConfig.json or nano webConfig.json
  • Edit the mongoUrl into mongodb://<mongo-IPAddress>:27017/test

Publishing a docker image

  • Run docker build -t username/repo -f cms.dockerfile .
  • Run docker login
  • Run docker push username/repo

Reference