colmena

 Free and Open Source 
Full Stack
RAPID API DEVELOPMENT

루프백 및 각도로 구동됩니다

에 대한

Colmena는 쉽게 확장 및 구축 할 수있는 관리자 인터페이스가있는 API의 스타터 키트입니다.

다음을 포함하되 이에 국한되지 않은 훌륭한 오픈 소스 프로젝트 모음을 사용하여 구축되었습니다.

• LOOPBACK -Express를 기반으로 한 API 서버.
• Angular -MVC 프레임 워크 웹 앱을 구축합니다.
• 루프백 SDK 빌더 - 루프백 및 각도의 멋진 통합.
• Coreui- 놀라운 부트 스트랩 관리자 템플릿.

켈 경고

이 소프트웨어는 활발한 개발 중입니다!

진행중인 작업 섹션의 문제를 해결하지 않고 제작에 사용하지 마십시오.

진행중인 작업

Colmena는 진행중인 작업이며 모든 기능이 아직 구축 된 것은 아닙니다.

• 기본 ACL 만 구현되므로 API는 액세스 할 수있는 사람이 API를 사용할 수 있습니다.
• 인터페이스는 사용자 역할 (관리자/관리자/사용자)을 반영하지 않습니다.
• 콘텐츠는 도메인에서 유출되지만 불가능하지 않아야합니다.

구조

이 프로젝트는 Lerna가 관리하는 모노 리포입니다. 다음과 같이 구성됩니다.

• apps/
  • angular로 구축 된 관리자 인터페이스를 admin .
  • api 나머지 API는 루프백으로 구축되었습니다.
• modules/
  • 관리자 앱에 기능을 추가하는 admin-* 모듈.
  • API 앱에 기능을 추가하는 api-* 모듈.
• packages/
  • 관리자 앱에서 사용하는 admin-* 패키지.
  • api-* API 앱에서 사용하는 패키지.

이 프로젝트의 구조는이 위대한 예에서 영감을 얻었습니다. OasisDigital/Scalable-Enterprise-angular.

설치

요구 사항

시스템에 설치된 소프트웨어 :

• node (v6.9.x 이상).
• npm (V3.X 이상).

전 세계적으로 설치된 노드 패키지 :

• 각도 CLI
• Lerna
• 루프백 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 Run 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 default.yaml을 복사하십시오.

샘플 데이터

API에는 개발을위한 샘플 데이터 세트가 제공됩니다.

API 업데이트 local.yaml 을 시작할 때 샘플 데이터를로드하려면 다음을 포함합니다.

 system :
  initdb : true

INITDB 환경 변수를 사용할 수도 있습니다.

API 기본 URL

기본적으로 개발 스택은 API와 관리자가 둘 다 로컬 호스트에서 시작되었다고 가정합니다 ( 127.0.0.1 사용).

LocalHost보다 다른 호스트에서 API를 실행하려면 관리자는 API에 도달 할 수있는 IP 주소를 알아야합니다. 이렇게하려면 api.baseUrl 구성 속성을 업데이트해야합니다.

후행 슬래시 없이 API베이스 URL을 구성하십시오.

API 기본 URL 업데이트 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 Compose 구성과 함께 제공됩니다.

Mongodb

mongodb 서버를 사용하려면 local.yaml 포함시키기 위해 다음을 포함 시키십시오.

 mongodb :
  url : mongodb://localhost/colmena

MONGODB_URL 환경 변수를 사용할 수도 있습니다

메일 호그

MailHog 서버 업데이트 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 ? ? ?	윌리안 리베이로 안젤로	Nick Portokallidis	Drmikecrowe	블라디미르 메카 우스 카스	베르나르도 아레 발로	이에 메임
브라이언 맥킨타이어	Rob Halff	Asgeir Birkisson	DTHIB	올레 쿠실	풀 키트 싱산	Tuan PM
브라운맨	Hoàng Phúc	브라이언 던 네트	첸츠	테르시우스 쿠네	Alex Quiambao	José Luis di Biase
지팡이.	알렉스 와일드	DMTW	마커스	브랜 논 N. 다비 II	Sebastian Podgajny	ISCASTER

이 프로젝트는 All-Contritors 사양을 따릅니다. 모든 종류의 공헌을 환영합니다!

후원자

매월 기부금으로 우리를 지원하고 활동을 계속할 수 있도록 도와주세요. [후원자가되기]

스폰서

귀하의 사이트에 대한 링크를 통해 스폰서가되어 Github의 README에 로고를 받으십시오. [후원자가되기]

이 프로젝트는 이전에 루프백 앵귤러 관리자로 알려져 있습니다.