colmena

 Free and Open Source 
Full Stack
RAPID API DEVELOPMENT

由回环和角驱动

关于

Colmena是具有管理界面的API的入门套件，可以轻松扩展和构建。

它是使用一系列出色的开源项目集合的，包括但不限于：

• LOOPBACK-基于Express的API服务器。
• Angular -MVC框架构建Web应用程序。
• 环回SDK构建器 - 环回和角的真棒集成。
• COREUI-惊人的引导管理模板。

配x警告

该软件正在积极开发中！

请在生产中不要在生产中使用它，而无需解决正在进行的工作部分中的问题

正在进行中

Colmena是一项正在进行的工作，并非所有功能都建立了。

• 仅实现了基本ACL，这意味着可以访问它的人可以使用API
• 该界面不反映用户角色（admin/Manager/用户）
• 内容将跨域泄漏，而这不可能

结构

该项目是由Lerna管理的一单元repo。它是这样的结构：

• apps/
  • admin用角构建的管理界面。
  • api用环回构建的REST API。
• modules/
  • admin-*模块将功能添加到管理应用程序。
  • api-*模块将功能添加到API应用程序中。
• packages/
  • admin-* Admin应用程序使用的软件包。
  • API应用程序使用的api-*软件包。

该项目的结构灵感来自这个伟大的例子：oasisdigital/scopar-enterprise-angular。

安装

要求

系统上安装的软件：

• node （v6.9.x或更高）。
• npm （v3.x或更高）。

全球安装的节点软件包：

• 角CLI
• 勒纳
• 回环CLI

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

设置

克隆存储库并安装依赖项：

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

发展

在开发模式下运行

当项目以开发模式运行时，当检测到代码更改时，API和管理员将自动重新启动。

URL

• API在http://127.0.0.1:3000上听。
• 管理员在http://127.0.0.1:9000上听。

开始项目

从项目中，dir运行npm run dev ：

npm run dev

这将在同一端子中同时启动API和管理员。

您也可以单独启动两个组件：

启动API

npm run dev:api

启动管理员

npm run dev:admin

清理项目

在开发过程中，将项目恢复到干净的状态可能很有用。进行此运行：

npm run clean && npm install && lerna bootstrap

配置开发设置

local.yaml

您可以通过在config中创建local.yaml文件来配置开发模式的API。该文件的内容不受GIT跟踪，因此仅在您的本地机器上生存。

首先以默认设置复制config/default.yaml到config/local.yaml 。

示例数据

API带有一组用于开发的示例数据。

在启动API Update local.yaml时，加载示例数据以：

 system :
  initdb : true

您也可以使用INITDB环境变量。

API基础网址

默认情况下，开发堆栈假设API和ADMIN都在Localhost上启动（使用127.0.0.1 ）。

为了在另一个主机上运行另一个主机上的API，管理员需要知道它可以在哪个IP地址到达API。为此，您需要更新api.baseUrl配置属性。

确保在无尾斜线的情况下配置API基础URL。

为了设置API base URL UPDATE local.yaml包括：

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

您也可以使用API_BASE_URL环境变量。

现在，您应该能够在http://192.168.12.34:9000上连接到管理员，并且应该连接到API。

开发服务器

Colmena配备了Docker组成的配置，可轻松运行开发服务器。

mongodb

要使用mongoDB服务器更新local.yaml ，以包括：

 mongodb :
  url : mongodb://localhost/colmena

您也可以使用MONGODB_URL环境变量

Mailhog

要使用MailHog Server Update local.yaml包含：

 smtp :
  host : localhost
  port : 1025

您也可以使用SMTP_HOST和SMTP_PORT环境变量

启动服务器

npm run servers # or: npm run servers:start 

显示服务器记录

npm run servers:logs

停止服务器

npm run servers:stop

删除服务器

npm run servers:rm

贡献者

谢谢这些好人（表情符号钥匙）：

Bram Borggreve ？ ？ ？	威利安·里贝罗·安吉洛（Willian Ribeiro Angelo）	尼克·波特卡利迪斯（Nick Portokallidis）	Drmikecrowe	Vladimir Mechkauskas	贝尔纳多·阿雷瓦洛（Bernardo Arevalo）	Yieme
Brian McIntyre	罗布·哈夫（Rob Halff）	Asgeir Birkisson	Dthib	Oleh Kukil	普尔基特·辛哈尔（Pulkit Singhal）	图安下午
布朗曼	hoàngphúc	布莱恩·邓内特（Brian Dunnette）	Chenzc	Tersius Kuhne	亚历克斯·Quiambao（Alex Quiambao）	JoséLuisdi Biase
刺。	亚历克斯·王尔德	DMTW	马库斯	Brannon N. Darby II	塞巴斯蒂安·波德加尼（Sebastian Podgany）	iScaster

该项目遵循全企业规范。欢迎任何形式的贡献！

支持者

每月捐款支持我们，并帮助我们继续我们的活动。 [成为支持者]

赞助商

成为赞助商，并在Github上获得徽标，并在Github上使用指向您网站的链接。 [成为赞助商]

该项目以前被称为环形角管理员。