colmena

 Free and Open Source 
Full Stack
RAPID API DEVELOPMENT

Питается на петле и угловой

О

Colmena - это стартовый комплект для API с интерфейсом администратора, который можно легко расширить и построить.

Он построен с использованием коллекции отличных проектов с открытым исходным кодом, включая, помимо прочего:

• Loopback - API -сервер на основе Express.
• Angular - MVC Framework для создания веб -приложений.
• Loopback SDK Builder - потрясающая интеграция петли и угловой.
• COREUI - Удивительный шаблон администратора начальной загрузки.

️ Предупреждение

Это программное обеспечение находится в активной разработке!

Пожалуйста, не используйте его в производстве, не решая проблемы в разделе «Работа»

Работа в процессе

Colmena находится в стадии разработки, и еще не все функциональности построены.

• Реализованы только основные ACL, это означает, что API может использоваться тем, кто имеет к нему доступ
• Интерфейс не отражает роль пользователя (администратор/менеджер/пользователь)
• Контент будет протекать через домены, а это не должно быть возможно

Структура

Проект-это моно-репо, управляемый Лерной. Это структурировано как это:

• apps/
  • admin интерфейс администратора, построенный с угловым.
  • api API REST, построенный с Loopback.
• modules/
  • admin-* Модули, которые добавляют функциональность в приложение Admin.
  • api-* Модули, которые добавляют функциональность в приложение API.
• packages/
  • admin-* Пакеты, используемые приложением администратора.
  • api-* Пакеты, используемые приложением API.

Структура этого проекта вдохновлена ​​этим отличным примером: оазисдигитал/масштабируемый инспектор-ангулярная.

Установка

Требования

Программное обеспечение установлено в вашей системе:

• node (v6.9.x или выше).
• npm (v3.x или выше).

Глобально установленные пакеты узлов:

• Угловой клин
• Лерна
• Loopback 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

Вы можете настроить API в режиме разработки, создав файл local.yaml в config . Содержание этого файла не отслеживается GIT, поэтому оно живет только на вашей местной машине.

Для начала с настройки по умолчанию копировать config/default.yaml в config/local.yaml .

Образец данных

API поставляется с набором образцов данных для разработки.

Чтобы загрузить образец данных при запуске обновления API local.yaml , чтобы включить:

 system :
  initdb : true

Вы также можете использовать переменную среды INITDB .

API Base URL

По умолчанию стек разработки предполагает, что API и администратор начинаются с Localhost (используя 127.0.0.1 ).

Чтобы запустить API на другом хосте, чем Localhost, администратор должен знать, на каком IP -адресу он может достичь API. Для этого вам нужно обновить свойство конфигурации api.baseUrl .

Обязательно настройте базовый URL -адрес API без следы зацепления.

Чтобы установить базовое URL -обновление API 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

Чтобы использовать обновление сервера 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

Участники

Спасибо этим замечательным людям (ключ эмодзи):

Брэм Борггрив ? ? ?	Виллиан Рибейро Анджело	Ник Портокаллидис	Drmikecrowe	Владимир Мечкаускас	Бернардо Аревало	Yieme
Брайан Макинтайр	Роб Халфф	Асгеир Биркиссон	dthib	Олех Кукил	Пулкит Сингхал	ТУАН ПМ
Браунман	Хоанг Фук	Брайан Даннетт	Chenzc	Терсиус Куэне	Алекс Квиамбао	Хосе Луис ди Биас
Шнур	Алекс Уайльд	DMTW	Маркус	Браннон Н. Дарби II	Себастьян Подгаджни	Iscaster

Этот проект следует за спецификацией всех контролей. Взносы любого вида приветствуются!

Покровители

Поддержите нас ежемесячным пожертвованием и помогите нам продолжить нашу деятельность. [Станьте покровителем]

Спонсоры

Станьте спонсором и получите свой логотип на нашем Readme на GitHub по ссылке на ваш сайт. [Станьте спонсором]

Этот проект был ранее известен как Angular Admin Loopback.