colmena

 Free and Open Source 
Full Stack
RAPID API DEVELOPMENT

ループバックと角度を搭載しています

について

Colmenaは、APIのスターターキットであり、管理インターフェイスを備えており、簡単に拡張して構築できます。

以下を含むがこれらに限定されない、優れたオープンソースプロジェクトのコレクションを使用して構築されています。

• Loopback -Expressに基づくAPIサーバー。
• Angular -MVCフレームワークWebアプリを構築する。
• ループバックSDKビルダー - ループバックと角度の素晴らしい統合。
• Coreui-素晴らしいブートストラップ管理テンプレート。

ショ和警告

このソフトウェアはアクティブな開発中です！

進行中の作業の問題に対処せずに、生産に使用しないでくださいセクション

進行中の作業

Colmenaは進行中の作業であり、すべての機能がまだ構築されているわけではありません。

• 基本的なACLのみが実装されています。これは、APIがアクセスできる人がAPIを使用できることを意味します。
• インターフェイスはユーザーの役割（管理者/マネージャー/ユーザー）を反映していません
• コンテンツはドメインを横切って漏れますが、これは不可能なはずです

構造

このプロジェクトは、レルナが管理するモノレポです。このように構成されています：

• apps/
  • Angularで構築されたadminインターフェイス。
  • apiループバックで構築されたREST API。
• modules/
  • 管理者アプリに機能を追加するadmin-*モジュール。
  • api-* APIアプリに機能を追加するモジュール。
• packages/
  • admin-*管理アプリが使用するパッケージ。
  • APIアプリで使用されるapi-*パッケージ。

このプロジェクトの構造は、この素晴らしい例に触発されています：oasisdigital/scalable-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 run npm run dev ：

npm run dev

これにより、APIと管理者の両方が同じ端末で開始されます。

2つのコンポーネントを個別に開始することもできます。

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アップデートlocal.yamlを起動するときにサンプルデータをロードするには、以下を含めます。

 system :
  initdb : true

INITDB環境変数を使用することもできます。

APIベースURL

デフォルトでは、開発スタックは、APIと管理者が両方ともLocalHostで開始されることを前提としています（ 127.0.0.1を使用）。

APIを別のホストでAPIを実行するためには、ローカルホストでは、管理者がどのIPアドレスをAPIに到達できるかを知る必要があります。これを行うには、 api.baseUrl configプロパティを更新する必要があります。

トレーリングスラッシュなしで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 Configurationが付属しています。

mongodb

Mongodb Serverを使用して、 local.yamlを含むようにします。

 mongodb :
  url : mongodb://localhost/colmena

MONGODB_URL環境変数も使用することもできます

Mailhog

Mailhog Serverを使用して、 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 ？ ？ ？	ウィリアン・リベロ・アンジェロ	ニック・ポルトカリディス	Drmikecrowe	ウラジミール・メカウスカ	ベルナルドアレバロ	Yieme
ブライアン・マッキンタイア	ロブ・ハルフ	Asgeir Birkisson	dthib	オレクキル	Pulkit Singhal	Tuan PM
ブラウンマン	HoàngPhuc	ブライアン・ダネット	chenzc	Tersius Kuhne	アレックス・クイアンバオ	ホセ・ルイス・ディ・バイアス
小屋。	アレックス・ワイルド	dmtw	マーカス	ブラノンN.ダービーII	セバスチャン・ポジャジ	イスカスター

このプロジェクトは、全委員会の仕様に従います。あらゆる種類の貢献を歓迎します！

支援者

毎月の寄付で私たちをサポートし、私たちが活動を続けるのを助けてください。 [支援者になる]

スポンサー

スポンサーになって、サイトへのリンクを使用して、GitHubのReadMeでロゴを取得します。 [スポンサーになる]

このプロジェクトは、以前はLoopback Angular Adminとして知られていました。