colmena

 Free and Open Source 
Full Stack
RAPID API DEVELOPMENT

Alimentado por loopback y angular

Acerca de

Colmena es un kit de inicio para una API con una interfaz de administración que se puede extender y construir fácilmente.

Se construye utilizando una colección de excelentes proyectos de código abierto, que incluyen, entre otros::

• Loopback - Servidor API basado en Express.
• Angular - Marco MVC para crear aplicaciones web.
• Bucleback SDK Builder: impresionante integración de Loopback y Angular.
• Coreui - Increíble plantilla de administración de bootstrap.

️ Advertencia

¡Este software está en desarrollo activo!

No lo use en producción sin abordar los problemas en la sección de trabajo en progreso

Trabajo en progreso

Colmena es un trabajo en progreso y aún no se construye toda la funcionalidad.

• Solo se implementan las ACL básicas, esto significa que la API puede ser utilizada por quien tenga acceso a ello
• La interfaz no refleja el rol de usuario (Admin/Manager/User)
• El contenido se filtrará a través de dominios, mientras que esto no debería ser posible

Estructura

El proyecto es un mono-repo administrado por Lerna. Está estructurado así:

• apps/
  • admin La interfaz de administración construida con angular.
  • api La API REST construida con Loopback.
• modules/
  • admin-* Módulos que agregan funcionalidad a la aplicación Admin.
  • api-* Módulos que agregan funcionalidad a la aplicación API.
• packages/
  • admin-* PACONES UTILIZADOS POR LA APLICACIÓN DE ADMING.
  • api-* PAQUETES UTILIZADOS POR LA APLICACIÓN API.

La estructura de este proyecto está inspirada en este gran ejemplo: oasisdigital/escalable-enterprise-angular.

Instalación

Requisitos

Software instalado en su sistema:

• node (v6.9.x o superior).
• npm (v3.x o superior).

Paquetes de nodo instalados a nivel mundial:

• CLI angular
• Lerna
• CLI de bucleback

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

Configuración

Clonar el repositorio e instalar las dependencias:

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

Desarrollo

Ejecutando en modo de desarrollo

Cuando el proyecto se ejecuta en modo de desarrollo, la API y el administrador se reiniciarán automáticamente cuando se detecte un cambio de código.

URLS

• La API escucha en http://127.0.0.1:3000.
• El administrador escucha en http://127.0.0.1:9000.

Comience el proyecto

Desde el interior del proyecto Dir Run npm run dev :

npm run dev

Esto comenzará tanto la API como el administrador en el mismo terminal.

También puede iniciar los dos componentes por separado:

Comienza la API

npm run dev:api

Iniciar el administrador

npm run dev:admin

Limpiar el proyecto

Durante el desarrollo puede ser útil devolver el proyecto a un estado limpio. Para hacer esta carrera:

npm run clean && npm install && lerna bootstrap

Configuración de la configuración de desarrollo

local.yaml

Puede configurar la API en modo de desarrollo creando un archivo local.yaml en config . El contenido de este archivo no es rastreado por GIT, por lo que solo vive en su máquina local.

Para comenzar con la configuración predeterminada, copie config/default.yaml a config/local.yaml .

Muestra de datos

La API viene con un conjunto de datos de muestra para el desarrollo.

Para cargar los datos de la muestra al comenzar la API Update local.yaml para incluir:

 system :
  initdb : true

También puede usar la variable de entorno INITDB .

URL de base de API

Por defecto, la pila de desarrollo supone que la API y el administrador se inician en Localhost (usando 127.0.0.1 ).

Para ejecutar la API en otro host que el local, el administrador debe saber en qué dirección IP puede llegar a la API. Para hacer esto, debe actualizar la propiedad api.baseUrl Config.

Asegúrese de configurar la URL base de la API sin una barra de corte.

Para establecer la actualización de URL base de la API local.yaml para incluir:

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

También puede usar la variable de entorno API_BASE_URL .

Ahora debería poder conectarse al administrador en http://192.168.12.34:9000 y debe conectarse a la API.

Servidores de desarrollo

Colmena viene con una configuración de composición de Docker para ejecutar servidores de desarrollo fácilmente.

mongodb

Para usar la actualización del servidor MongoDB local.yaml para incluir:

 mongodb :
  url : mongodb://localhost/colmena

También puede usar la variable de entorno MONGODB_URL

Morrahog

Para usar la actualización del servidor Mailhog local.yaml para incluir:

 smtp :
  host : localhost
  port : 1025

También puede usar las variables de entorno SMTP_HOST y SMTP_PORT

Inicie los servidores

npm run servers # or: npm run servers:start 

Mostrar el registro de los servidores

npm run servers:logs

Detener los servidores

npm run servers:stop

Eliminar los servidores

npm run servers:rm

Colaboradores

Gracias a estas maravillosas personas (Key Emoji):

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
marrón	Hoàng phúc	Brian Dunnette	Chenzc	Tersius Kuhne	Alex Quiambbao	José Luis di Biase
Shing.	Alex Wilde	dmtw	Marco	Brannon N. Darby II	Sebastian podgajny	Iscaster

Este proyecto sigue la especificación de todos los contribuyentes. ¡Contribuciones de cualquier tipo bienvenido!

Patrocinadores

Apóyanos con una donación mensual y ayúdanos a continuar nuestras actividades. [Conviértete en un patrocinador]

Patrocinadores

Conviértase en patrocinador y obtenga su logotipo en nuestro Readme en GitHub con un enlace a su sitio. [Convertirse en patrocinador]

Este proyecto fue conocido anteriormente como Loopback Angular Admin.