colmena

 Free and Open Source 
Full Stack
RAPID API DEVELOPMENT

Angetrieben von Loopback und Angular

Um

Colmena ist ein Starter -Kit für eine API mit einer Admin -Schnittstelle, die leicht verlängert und aufgebaut werden kann.

Es wird mit einer Sammlung großartiger Open -Source -Projekte gebaut, einschließlich, aber nicht beschränkt auf:

• Loopback - API -Server basierend auf Express.
• Angular - MVC -Framework zum Erstellen von Web -Apps.
• Loopback SDK Builder - Awesome Integration von Loopback und Angular.
• CoreUi - Erstaunliche Bootstrap -Administratorvorlage.

Euen Warnung

Diese Software befindet sich unter aktiver Entwicklung!

Bitte verwenden Sie es nicht in der Produktion, ohne die Probleme im Abschnitt "In Progress" zu beheben

In Arbeit arbeiten

Colmena ist in Arbeit und noch nicht alle Funktionen sind aufgebaut.

• Es werden nur grundlegende ACLs implementiert. Dies bedeutet, dass die API von jedem Zugriff darauf verwendet werden kann
• Die Schnittstelle spiegelt die Benutzerrolle nicht wider (Administrator/Manager/Benutzer)
• Inhalte werden über Domänen hinausgehen, während dies nicht möglich sein sollte

Struktur

Das Projekt ist ein von Lerna verwaltetes Mono-Repo. Es ist so strukturiert:

• apps/
  • admin die mit Angular erstellte Admin -Schnittstelle.
  • api Rest -API mit Loopback.
• modules/
  • admin-* Module, die der Admin-App Funktionalität hinzufügen.
  • api-* Module, die der API-App Funktionalität hinzufügen.
• packages/
  • admin-* Pakete, die von der Admin-App verwendet werden.
  • api-* Pakete, die von der API-App verwendet werden.

Die Struktur dieses Projekts ist von diesem großartigen Beispiel inspiriert: Oasisdigital/skalierbarer Einflusswinkel.

Installation

Anforderungen

Software, die auf Ihrem System installiert ist:

• node (v6.9.x oder höher).
• npm (v3.x oder höher).

Global installierte Knotenpakete:

• Angular Cli
• Lerna
• Loopback Cli

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

Aufstellen

Klonen Sie das Repository und installieren Sie die Abhängigkeiten:

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

Entwicklung

Laufen im Entwicklungsmodus

Wenn das Projekt im Entwicklungsmodus ausgeführt wird, wird die API und der Administrator automatisch neu gestartet, wenn eine Codeänderung erkannt wird.

URLs

• Die API hört unter http://127.0.0.1:3000 zu.
• Der Administrator hört auf http://127.0.0.1:9000.

Starten Sie das Projekt

Aus dem Projekt Dir Run npm run dev :

npm run dev

Dies startet sowohl die API als auch den Administrator im selben Terminal.

Sie können auch die beiden Komponenten separat starten:

Starten Sie die API

npm run dev:api

Starten Sie den Administrator

npm run dev:admin

Reinigen Sie das Projekt

Während der Entwicklung kann es nützlich sein, das Projekt in einen sauberen Zustand zurückzubringen. Um diesen Lauf zu machen:

npm run clean && npm install && lerna bootstrap

Konfigurieren des Entwicklungsaufbaus

local.yaml

Sie können die API im Entwicklungsmodus konfigurieren, indem Sie eine local.yaml -Datei in config erstellen. Der Inhalt dieser Datei wird von Git nicht verfolgt, sodass sie nur auf Ihrer lokalen Maschine lebt.

Um mit den Standardeinstellungen zu beginnen, kopieren Sie config/default.yaml auf config/local.yaml .

Beispieldaten

Die API verfügt über eine Reihe von Beispieldaten für die Entwicklung.

So laden Sie die Beispieldaten beim Starten der API -Aktualisierung local.yaml um Folgendes zu enthalten:

 system :
  initdb : true

Sie können auch die INITDB -Umgebungsvariable verwenden.

API -Basis -URL

Standardmäßig geht der Entwicklungsstapel davon aus, dass die API und die Administrator beide auf Localhost (unter Verwendung von 127.0.0.1 ) gestartet werden.

Um die API auf einem anderen Host auszuführen als Localhost, muss der Administrator wissen, über welche IP -Adresse die API erreichen kann. Dazu müssen Sie die api.baseUrl -Konfigurationseigenschaft aktualisieren.

Stellen Sie sicher, dass Sie die API -Basis -URL ohne nachverfolgende Schrägstrich konfigurieren.

So setzen Sie die API -Basis -URL -Aktualisierung local.yaml ein, um Folgendes zu enthalten:

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

Sie können auch die Umgebungsvariable API_BASE_URL verwenden.

Sie sollten nun in der Lage sein, eine Verbindung zum Administrator unter http://192.168.12.34:9000 herzustellen, und es sollte eine Verbindung zur API herstellen.

Entwicklungsserver

Colmena wird mit einer Docker -Komponierungskonfiguration für die Ausführung von Entwicklungsservern problemlos geliefert.

MongoDb

Verwenden Sie den MongoDB Server -Update local.yaml , um zu enthalten:

 mongodb :
  url : mongodb://localhost/colmena

Sie können auch die Umgebungsvariable MONGODB_URL verwenden

Mailhog

Um den MailHog Server -Aktualisieren local.yaml zu verwenden, um zu enthalten:

 smtp :
  host : localhost
  port : 1025

Sie können auch die Umgebungsvariablen SMTP_HOST und SMTP_PORT verwenden

Starten Sie die Server

npm run servers # or: npm run servers:start 

Zeigen Sie die Server anmelden

npm run servers:logs

Stoppen Sie die Server

npm run servers:stop

Löschen Sie die Server

npm run servers:rm

Mitwirkende

Vielen Dank an diese wunderbaren Menschen (Emoji -Schlüssel):

Bram Borgreve ? ? ?	Willian Ribeiro Angelo	Nick Portokallidis	drmikecree	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

Dieses Projekt folgt der All-Contributors-Spezifikation. Beiträge jeglicher Art willkommen!

Unterstützer

Unterstützen Sie uns mit einer monatlichen Spende und helfen Sie uns, unsere Aktivitäten fortzusetzen. [Backer werden]

Sponsoren

Werden Sie Sponsor und holen Sie sich Ihr Logo auf unserem Readme auf GitHub mit einem Link zu Ihrer Website. [Sponsor werden]

Dieses Projekt war früher als Loopback Angular Admin bekannt.