colmena

 Free and Open Source 
Full Stack
RAPID API DEVELOPMENT

Propulsé par Loopback et Angular

À propos

Colmena est un kit de démarrage pour une API avec une interface d'administration qui peut être facilement étendue et construite.

Il est construit en utilisant une collection de grands projets open source, y compris, mais sans s'y limiter:

• LOOPBACK - Server API basé sur Express.
• Framework Angular - MVC pour créer des applications Web.
• Loopback SDK Builder - Awesome Integration of Loopback et Angular.
• CoreUi - modèle d'administration bootstrap incroyable.

️ Avertissement

Ce logiciel est en cours de développement actif!

Veuillez ne pas l'utiliser en production sans résoudre les problèmes de la section des travaux en cours

Travail en cours

Colmena est un travail en cours et toutes les fonctionnalités ne sont pas encore construites.

• Seuls les ACL de base sont implémentés, cela signifie que l'API peut être utilisée par quiconque y a accès
• L'interface ne reflète pas le rôle utilisateur (administrateur / manager / utilisateur)
• Le contenu fuira à travers les domaines, alors que cela ne devrait pas être possible

Structure

Le projet est un mono-repo géré par Lerna. Il est structuré comme ceci:

• apps/
  • admin l'interface d'administration construite avec Angular.
  • api L'API REST construite avec Loopback.
• modules/
  • Modules admin-* qui ajoutent des fonctionnalités à l'application Admin.
  • modules api-* qui ajoutent des fonctionnalités à l'application API.
• packages/
  • packages admin-* utilisés par l'application admin.
  • Packages api-* utilisés par l'application API.

La structure de ce projet est inspirée par ce excellent exemple: Oasisdicital / Scolable-Entrise-Angular.

Installation

Exigences

Logiciel installé sur votre système:

• node (v6.9.x ou supérieur).
• npm (v3.x ou supérieur).

Packages de nœuds installés à l'échelle mondiale:

• CLI angulaire
• Lerna
• CLI LOOPBACK

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

Installation

Clone le référentiel et installer les dépendances:

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

Développement

Exécution en mode développement

Lorsque le projet s'exécute en mode développement, l'API et l'administrateur redémarrent automatiquement lorsqu'une modification de code est détectée.

URL

• L'API écoute http://127.0.0.1:3000.
• L'administrateur écoute http://127.0.0.1:9000.

Démarrer le projet

De l'intérieur du projet DIR RUN npm run dev :

npm run dev

Cela commencera à la fois l'API et l'administrateur dans le même terminal.

Vous pouvez également démarrer les deux composants séparément:

Démarrer l'API

npm run dev:api

Démarrer l'administrateur

npm run dev:admin

Nettoyez le projet

Pendant le développement, il peut être utile de ramener le projet à un état propre. Pour faire cette course:

npm run clean && npm install && lerna bootstrap

Configuration de la configuration du développement

local.yaml

Vous pouvez configurer l'API en mode développement en créant un fichier local.yaml dans config . Le contenu de ce fichier n'est pas suivi par GIT, il ne vit donc que sur votre machine locale.

Pour démarrer avec les paramètres par défaut, copiez config/default.yaml à config/local.yaml .

Échantillons de données

L'API est livrée avec un ensemble d'échantillons de données pour le développement.

Pour charger les exemples de données lors du démarrage de la mise à jour de l'API local.yaml pour inclure:

 system :
  initdb : true

Vous pouvez également utiliser la variable d'environnement INITDB .

URL de base de l'API

Par défaut, la pile de développement suppose que l'API et l'administrateur sont tous deux démarrés sur LocalHost (en utilisant 127.0.0.1 ).

Afin d'exécuter l'API sur un autre hôte que localhost, l'administrateur doit savoir sur quelle adresse IP peut atteindre l'API. Pour ce faire, vous devez mettre à jour la propriété api.baseUrl Config.

Assurez-vous de configurer l'URL de base de l'API sans barre de barrage.

Pour définir la mise à jour de l'URL de base de l'API local.yaml pour inclure:

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

Vous pouvez également utiliser la variable d'environnement API_BASE_URL .

Vous devriez maintenant pouvoir vous connecter à l'administrateur sur http://192.168.12.34:9000 et il devrait se connecter à l'API.

Serveurs de développement

Colmena est livré avec une configuration Docker Compose pour exécuter facilement les serveurs de développement.

mongodb

Pour utiliser la mise à jour du serveur MongoDB local.yaml pour inclure:

 mongodb :
  url : mongodb://localhost/colmena

Vous pouvez également utiliser la variable d'environnement MONGODB_URL

courrier

Pour utiliser la mise à jour du serveur MailHog local.yaml pour inclure:

 smtp :
  host : localhost
  port : 1025

Vous pouvez également utiliser les variables d'environnement SMTP_HOST et SMTP_PORT

Démarrer les serveurs

npm run servers # or: npm run servers:start 

Afficher la journalisation des serveurs

npm run servers:logs

Arrêter les serveurs

npm run servers:stop

Supprimer les serveurs

npm run servers:rm

Contributeurs

Merci à ces gens merveilleux (clé emoji):

Bram ? ? ?	Willian Ribeiro Angelo	Nick Portokallidis	drmikecrowe	Vladimir mechkauskas	Bernardo Arevalo	yieme
Brian McIntyre	Rob Halff	Asgeir birkisson	dthib	Oleh Kukil	Pulkit Singhal	Tuan PM
brun	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

Ce projet suit les spécifications de tous les contributeurs. Contributions de toute nature bienvenue!

Bailleurs de fonds

Soutenez-nous avec un don mensuel et nous aidez à poursuivre nos activités. [Devenez un bailleur de fonds]

Sponsors

Devenez sponsor et obtenez votre logo sur notre lecture sur GitHub avec un lien vers votre site. [Devenir sponsor]

Ce projet était autrefois connu sous le nom de Loopback Angular Admin.