colmena

 Free and Open Source 
Full Stack
RAPID API DEVELOPMENT

Alimentado por loopback e angular

Sobre

Colmena é um kit inicial para uma API com uma interface de administrador que pode ser facilmente estendida e construída.

Ele é construído usando uma coleção de ótimos projetos de código aberto, incluindo, entre outros,:

• Loopback - servidor de API com base no Express.
• Estrutura Angular - MVC para criar aplicativos da Web.
• Loopback SDK Builder - Integração impressionante de loopback e angular.
• COREUI - Modelo de administração incrível de bootstrap.

️ Aviso

Este software está em desenvolvimento ativo!

Por favor, não o use na produção sem resolver os problemas na seção de trabalho em andamento

Trabalho em andamento

Colmena é um trabalho em andamento e nem toda funcionalidade foi construída ainda.

• Somente ACLs básicos são implementados, isso significa que a API pode ser usada por quem tem acesso a ele
• A interface não reflete a função do usuário (admin/gerente/usuário)
• O conteúdo estará vazando entre domínios, enquanto isso não deve ser possível

Estrutura

O projeto é um mono-repo gerenciado por Lerna. Está estruturado assim:

• apps/
  • admin a interface do administrador construída com o Angular.
  • api A API REST construída com loopback.
• modules/
  • admin-* Módulos que adicionam funcionalidade ao aplicativo Admin.
  • Módulos api-* que adicionam funcionalidade ao aplicativo API.
• packages/
  • admin-* pacotes usados ​​pelo aplicativo Admin.
  • pacotes api-* usados ​​pelo aplicativo API.

A estrutura deste projeto é inspirada por este ótimo exemplo: OasisDigital/Scalable-Enterprise-Angular.

Instalação

Requisitos

Software instalado em seu sistema:

• node (v6.9.x ou superior).
• npm (v3.x ou superior).

Pacotes de nós instalados globalmente:

• CLI angular
• LERNA
• LOOPBACK CLI

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

Configurar

Clone o repositório e instale as dependências:

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

Desenvolvimento

Executando em modo de desenvolvimento

Quando o projeto estiver em execução no modo de desenvolvimento, a API e o administrador serão reiniciados automaticamente quando uma alteração de código for detectada.

URLs

• A API ouve em http://127.0.0.1:3000.
• O administrador ouve em http://127.0.0.1:9000.

Inicie o projeto

De dentro do projeto Dir Run npm run dev :

npm run dev

Isso iniciará a API e o administrador no mesmo terminal.

Você também pode iniciar os dois componentes separadamente:

Inicie a API

npm run dev:api

Inicie o administrador

npm run dev:admin

Limpe o projeto

Durante o desenvolvimento, pode ser útil trazer o projeto de volta a um estado limpo. Para fazer isso:

npm run clean && npm install && lerna bootstrap

Configurando a configuração de desenvolvimento

local.yaml

Você pode configurar a API no modo de desenvolvimento, criando um arquivo local.yaml na config . O conteúdo deste arquivo não é rastreado pelo Git, por isso vive apenas em sua máquina local.

Para começar com as configurações padrão copy config/default.yaml para config/local.yaml .

Dados de amostra

A API vem com um conjunto de dados de amostra para desenvolvimento.

Para carregar os dados da amostra ao iniciar a atualização da API local.yaml para incluir:

 system :
  initdb : true

Você também pode usar a variável de ambiente INITDB .

URL base da API

Por padrão, a pilha de desenvolvimento pressupõe que a API e o administrador sejam iniciados no localhost (usando 127.0.0.1 ).

Para executar a API em outro host que o localhost, o administrador precisa saber em qual endereço IP ele pode atingir a API. Para fazer isso, você precisa atualizar a propriedade api.baseUrl Config.

Certifique -se de configurar o URL da base da API sem uma barra à direita.

Para definir o URL base da API Update local.yaml para incluir:

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

Você também pode usar a variável de ambiente API_BASE_URL .

Agora você deve se conectar ao admin em http://192.168.12.34:9000 e ele deve se conectar à API.

Servidores de desenvolvimento

Colmena vem com uma configuração do Docker Compõe para executar servidores de desenvolvimento com facilidade.

MongoDB

Para usar a atualização do servidor MongoDB local.yaml para incluir:

 mongodb :
  url : mongodb://localhost/colmena

Você também pode usar a variável de ambiente MONGODB_URL

MailHog

Para usar a atualização do MaHHog Server local.yaml para incluir:

 smtp :
  host : localhost
  port : 1025

Você também pode usar as variáveis ​​de ambiente SMTP_HOST e SMTP_PORT

Inicie os servidores

npm run servers # or: npm run servers:start 

Mostre o registro dos servidores

npm run servers:logs

Pare os servidores

npm run servers:stop

Exclua os servidores

npm run servers:rm

Colaboradores

Obrigado a essas pessoas maravilhosas (key emoji):

BRAM BORGGREVE ? ? ?	Willian Ribeiro Angelo	Nick Portokallidis	drmikecrowe	Vladimir Mechkauskas	Bernardo Arevalo	yieme
Brian McIntyre	Rob Halff	Asgeir Birkisson	dthib	Oleh Kukil	Pulkit Singhal	Tuan PM
Brownman	Hoàng phúc	Brian Dunnette	Chenzc	Tersius Kuhne	Alex Quiambao	José Luis di Biase
Shing.	Alex Wilde	dmtw	Marcus	Brannon N. Darby II	Sebastian Podgajny	Iscaster

Este projeto segue a especificação de todos os contribuintes. Contribuições de qualquer tipo de boas -vindas!

Patrocinadores

Apoie -nos com uma doação mensal e ajude -nos a continuar nossas atividades. [Torne -se um patrocinador]

Patrocinadores

Torne -se um patrocinador e obtenha seu logotipo em nosso ReadMe no GitHub com um link para o seu site. [Torne -se um patrocinador]

Este projeto era anteriormente conhecido como Administrador Angular Loopback.