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上使用指向您網站的鏈接。 [成為贊助商]

該項目以前被稱為環形角管理員。