🍯 Free and Open Source development platform to quickly build modular content management systems using TypeScript
TypeScript HTML JavaScript CSS
Clone or download
Latest commit 8d07020 Nov 29, 2017
Permalink
Failed to load latest commit information.
.github chore: rename from Colmena CMS to Colmena Jun 1, 2017
apps chore(admin): format files using prettier Nov 9, 2017
config feat(api): move config folder to top-level Nov 9, 2017
extensions build: add extensions directory to lerna Jun 20, 2017
modules chore: remove file yarn.lock and ignore yarn.lock file (#356) Nov 16, 2017
packages chore(admin-lb-sdk): update admin-lb-sdk, using 'npm run sdk' Nov 20, 2017
storage feat(api): use TypeScript on the API Nov 9, 2017
.all-contributorsrc Add @IsCaster as a contributor Nov 4, 2017
.dockerignore chore: fix Docker setup Oct 27, 2017
.editorconfig Initial commit Oct 23, 2016
.eslintignore style: clean up formatting with npm run lint Jun 12, 2017
.gitattributes Dotfiles Jul 31, 2014
.gitignore chore: remove file yarn.lock and ignore yarn.lock file (#356) Nov 16, 2017
.npmrc chore: make sure all packages save exact dependency version Jun 12, 2017
.prettierignore chore: add prettier, lint-staged and husky for automatic formatting Nov 9, 2017
.prettierrc chore: add prettier, lint-staged and husky for automatic formatting Nov 9, 2017
.travis.yml feat(api): use TypeScript on the API Nov 9, 2017
CODE_OF_CONDUCT.md docs: add Code of Conduct Feb 19, 2017
CONTRIBUTING.md docs: update instructions on submitting a PR in CONTRIBUTING.md Nov 6, 2017
Dockerfile feat(api): move config folder to top-level Nov 9, 2017
LICENSE Merge branch 'wip' into colmena-cms Jan 16, 2017
README.md docs(README): remove codesponsor badge :( Nov 30, 2017
circle.yml feat(api): use TypeScript on the API Nov 9, 2017
docker-compose.app.yml build: add Docker Compose file and shortcuts Jun 19, 2017
docker-compose.servers.yml build: add Docker Compose file and shortcuts Jun 19, 2017
lerna.json chore: format files using prettier Nov 9, 2017
nodemon.json chore: format files using prettier Nov 9, 2017
package.json chore: use concurrently to load dev servers Nov 30, 2017
postinstall.js chore: format files using prettier Nov 9, 2017
production.json chore: fix Docker setup Oct 27, 2017
tsconfig.json feat(api): use TypeScript on the API Nov 9, 2017
tslint.json chore: format files using prettier Nov 9, 2017

README.md


Free and Open Source 
Full Stack
RAPID API DEVELOPMENT

Powered by LoopBack and Angular


About

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

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

⚠️ Warning

This software is under active development!

Please do not use it in production without addressing the issues in the Work in Progress section

Work in Progress

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

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

Structure

The project is a mono-repo managed by lerna. It is structured like this:

  • apps/
    • admin The Admin interface built with Angular.
    • api The REST API built with LoopBack.
  • modules/
    • admin-* Modules that add functionality to the Admin app.
    • api-* Modules that add functionality to the API app.
  • packages/
    • admin-* Packages used by the Admin app.
    • api-* Packages used by the API app.

The structure of this project is inspired by this great example: OasisDigital/scalable-enterprise-angular.

Installation

Requirements

Software installed on your system:

  • node (v6.9.x or higher).
  • npm (v3.x or higher).

Globally installed Node packages:

npm install -g @angular/cli lerna loopback-cli

Setup

Clone the repository and install the dependencies:

git clone https://github.com/colmena/colmena
cd colmena
npm install
lerna bootstrap

Development

Running in development mode

When the project is running in development mode the API and the Admin will restart automatically when a code change is detected.

URLs

Start the project

From inside the project dir run npm run dev:

npm run dev

This will start both the API and the Admin in the same terminal.

You can also start the two components separately:

Start the API

npm run dev:api

Start the Admin

npm run dev:admin

Clean up the project

During development it can be useful to bring the project back to a clean state. To do this run:

npm run clean && npm install && lerna bootstrap

Configuring the development setup

local.yaml

You can configure the API in development mode by creating a local.yaml file in config. The contents of this file is not tracked by git so it only lives on your local machine.

To start with the default settings copy config/default.yaml to config/local.yaml.

Sample data

The API comes with a set of sample data for development.

To load the sample data when starting the API update local.yaml to include:

system:
  initdb: true

You can also use the INITDB environment variable.

API Base Url

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

In order to run the API on another host than localhost the admin needs to know on which IP address it can reach the API. To do this you need to update the api.baseUrl config property.

Make sure to configure the API Base Url without a trailing slash.

To set the API Base Url update local.yaml to include:

api:
  # Do not use trailing spaces for the baseUrl
  baseUrl: http://192.168.12.34:3000

You can also use the API_BASE_URL environment 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.

Development Servers

Colmena comes with a Docker Compose configuration for running development servers easily.

mongodb

To use the mongodb server update local.yaml to include:

mongodb:
  url: mongodb://localhost/colmena

You can also use the MONGODB_URL environment variable

mailhog

To use the mailhog server update local.yaml to include:

smtp:
  host: localhost
  port: 1025

You can also use the SMTP_HOST and SMTP_PORT environment variables

Start the servers

npm run servers # or: npm run servers:start

Show the servers logging

npm run servers:logs

Stop the servers

npm run servers:stop

Delete the servers

npm run servers:rm

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

πŸ’»

Marcus

πŸ’»

Brannon N. Darby II

πŸ’»

Sebastian Podgajny

πŸ’»

IsCaster

πŸ’»

This project follows the all-contributors specification. Contributions of any kind welcome!

Backers

Support us with a monthly donation and help us continue our activities. [Become a backer]

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]

This project was formerly known as Loopback Angular Admin.