Colmena CMS

Free and Open Source API and Admin powered by LoopBack and Angular

TPFKALAA

This is a complete rewrite of The Project Formerly Known As Loopback Angular Admin.

Warning

This software is under 'active' development!

Please do not use it in production as-is.

Please refer to the Work in Progress section to find out what needs to be implemented to be production ready

About

Colmena CMS is a starter kit for an API with an Admin interface that can be easily extended and built upon.

Components

It is built using a collection of great Open Source projects, including but not limited to:

LoopBack v2.x - API server based on Express.
Angular v4.x + - MVC framework to build web apps.
Fireloop - Awesome Real-Time integration of Loopback and Angular.
CoreUI - Amazing Bootstrap Admin Template.

Installation

The project consists of 2 components, the API and the Admin interface.

Requirements

This project is built with node and therefore node (v6.x) and npm (v3.x) need to be available on your machine.

Additionally it uses p-s to run the project, which is recommended to be installed globally:

$ npm i -g p-s

Clone repo

First clone the repository to get the project files:

$ git clone https://github.com/colmena/colmena-cms
$ cd colmena-cms

Top-level directory

From inside the project dir (colmena-cms) run npm install:

$ npm install

This command should also trigger running npm install in the API and Admin directories using the npm postinstall step.

API (manual install of dependencies)

From inside the project dir (colmena-cms) enter the api directory and run npm install:

$ cd api
$ npm install

Admin (manual install of dependencies)

From inside the project dir (colmena-cms) enter the admin directory and run npm install:

$ cd admin
$ npm install

Development

Currently there is now way to build the project, it can only be run in development mode.

Running in development mode

From inside the project dir (colmena-cms) run INITDB=1 nps dev:

$ INITDB=1 nps dev

This will start the API and the Admin in the same terminal, and by using INITDB=1 the sample data will be loaded.

The API listens on http://0.0.0.0:3000.
The Admin listens on http://0.0.0.0:9000.

You can also start the two components separately:

Start the API

$ cd api
$ nps dev

Start the Admin

$ cd admin
$ nps dev

Running on other host than localhost

By default the development stack assumes that the API and Admin are both started on localhost (using 0.0.0.0).

When this is not the case, the admin needs to know on which IP address it can reach the API. In order to do this, you need to specify the api.baseUrl config property, which you can control using the API_BASE_URL environment variable.

$ API_BASE_URL=http://192.168.12.34:3000 nps dev

Make sure to leave out the trailing slash in the API_BASE_URL variable.

You should now be able to connect to the Admin on http://192.168.12.34:9000 and it should connect to the API.

More commands

For a list of all the commands available run nps in the project dir or in one of the components.

Work in Progress

Colmena CMS is still a work in progress and not all functionality is built yet.

Almost no ACLS are implemented, this means that the API can be used by whoever has access to it
There is no advanced user management
The interface does not reflect the user role (admin/manager/user)
Content will be leaking across domains, while this should not be possible

Known issues

npm WARN [dependency] requires a peer of @angular/[package] but none was installed.

This is a warning and can be safely ignored.

The reason this warning is shown is because Colmena CMS Admin uses Angular 4.x but depends on a couple of packages that expect Angular 2.x. This will be resolved when the dependencies are going to support Angular 4.

The element is deprecated. Use instead
This is a warning and can be safely ignored.

In Angular 4 `<template>` got deprecated in favor of `<ng-template>`. While Colmena CMS Admin has upgraded, most of its dependencies still use `<template>`. This will be resolved when the dependencies are going to update this.

Contributors

Thanks goes to these wonderful people (emoji key):

_{Bram Borggreve} 💬 🐛 💻 🎨 📖 🔧	_{Willian Ribeiro Angelo} 💻	_{Nick Portokallidis} 💻	_drmikecrowe 💻	_{Vladimir Mechkauskas} 💻	_{Bernardo Arevalo} 💻	_yieme 💻
_{Brian McIntyre} 💻	_{Rob Halff} 💻	_{Asgeir Birkisson} 💻	_dthib 💻	_{Oleh Kukil} 💻	_{Pulkit Singhal} 💻	_{Tuan PM} 💻
_brownman 💻	_{Hoàng Phúc} 💻	_{Brian Dunnette} 💻	_Chenzc 💻	_{Tersius Kuhne} 💻	_{Alex Quiambao} 💻	_{José Luis Di Biase} 💻
_Shing. 💻	_{Alex Wilde} 💻	_dmtw 💻