Skip to content

Files

Latest commit

b492105 · Jul 13, 2017

History

History
47 lines (40 loc) · 1.8 KB

README.md

File metadata and controls

47 lines (40 loc) · 1.8 KB

About

This is a project seed for an API with an Admin interface that can be easily extended and built upon, borrowed from Colmena but only reserves code structure and basic configuration to make it clean.

Introduction

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

  • LoopBack - API server based on Express.
  • Angular - MVC framework to build web apps.
  • LoopBack SDK Builder - Awesome integration of Loopback and Angular.
  • CoreUI - Amazing Bootstrap Admin Template.
  • @ngrx/store - RxJS powered state management for Angular applications

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.

Installation

Requirements

  • 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/dreamdevil00/angular2-loopbackjs-project-seed.git
cd angular2-loopbackjs-project-seed
npm install