colmena

 Free and Open Source 
Full Stack
RAPID API DEVELOPMENT

Didukung oleh loopback dan sudut

Tentang

Colmena adalah starter kit untuk API dengan antarmuka admin yang dapat dengan mudah diperluas dan dibangun.

Dibangun menggunakan koleksi proyek open source yang hebat, termasuk tetapi tidak terbatas pada:

• Loopback - API Server Berdasarkan Express.
• Angular - MVC Framework Untuk Membangun Aplikasi Web.
• Loopback SDK Builder - Integrasi Loopback dan Angular yang Luar Biasa.
• COREUI - Template admin bootstrap yang luar biasa.

️ Peringatan

Perangkat lunak ini sedang dalam pengembangan aktif!

Harap jangan menggunakannya dalam produksi tanpa membahas masalah di bagian pekerjaan dalam kemajuan

Bekerja dalam proses

Colmena adalah pekerjaan yang sedang berlangsung dan belum semua fungsionalitas dibangun.

• Hanya ACL dasar yang diimplementasikan, ini berarti bahwa API dapat digunakan oleh siapa pun yang memiliki akses ke sana
• Antarmuka tidak mencerminkan peran pengguna (admin/manajer/pengguna)
• Konten akan bocor di seluruh domain, sementara ini tidak mungkin

Struktur

Proyek ini adalah mono-repo yang dikelola oleh Lerna. Terstruktur seperti ini:

• apps/
  • admin antarmuka admin dibangun dengan sudut.
  • api REST API Dibangun dengan Loopback.
• modules/
  • admin-* Modul yang menambah fungsionalitas ke aplikasi admin.
  • Modul api-* yang menambah fungsionalitas ke aplikasi API.
• packages/
  • admin-* Paket yang digunakan oleh aplikasi admin.
  • Paket api-* yang digunakan oleh aplikasi API.

Struktur proyek ini terinspirasi oleh contoh yang bagus ini: oasisdigital/scalable-enterprise-angular.

Instalasi

Persyaratan

Perangkat lunak yang diinstal pada sistem Anda:

• node (v6.9.x atau lebih tinggi).
• npm (v3.x atau lebih tinggi).

Paket simpul yang diinstal secara global:

• CLI Angular
• Lerna
• Loopback CLI

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

Pengaturan

Klon Repositori dan instal dependensi:

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

Perkembangan

Berjalan dalam mode pengembangan

Ketika proyek berjalan dalam mode pengembangan API dan admin akan restart secara otomatis ketika perubahan kode terdeteksi.

URL

• API mendengarkan di http://127.0.0.1:3000.
• Admin mendengarkan di http://127.0.0.1:9000.

Mulai proyek

Dari dalam proyek Dir Run npm run dev :

npm run dev

Ini akan memulai API dan admin di terminal yang sama.

Anda juga dapat memulai dua komponen secara terpisah:

Mulai API

npm run dev:api

Mulai admin

npm run dev:admin

Bersihkan proyek

Selama pengembangan dapat bermanfaat untuk membawa proyek kembali ke keadaan bersih. Untuk melakukan ini menjalankan:

npm run clean && npm install && lerna bootstrap

Mengkonfigurasi Pengaturan Pengembangan

local.yaml

Anda dapat mengonfigurasi API dalam mode pengembangan dengan membuat file local.yaml di config . Isi file ini tidak dilacak oleh git sehingga hanya hidup di mesin lokal Anda.

Untuk memulai dengan pengaturan default, salin config/default.yaml ke config/local.yaml .

Data sampel

API dilengkapi dengan satu set data sampel untuk pengembangan.

Untuk memuat data sampel saat memulai API Update local.yaml untuk memasukkan:

 system :
  initdb : true

Anda juga dapat menggunakan variabel Lingkungan INITDB .

URL dasar API

Secara default tumpukan pengembangan mengasumsikan bahwa API dan admin keduanya dimulai pada localhost (menggunakan 127.0.0.1 ).

Untuk menjalankan API pada host lain daripada localhost, admin perlu tahu di mana alamat IP dapat mencapai API. Untuk melakukan ini, Anda perlu memperbarui properti konfigurasi api.baseUrl .

Pastikan untuk mengkonfigurasi URL dasar API tanpa tebasan trailing.

Untuk mengatur pembaruan URL basis API local.yaml untuk memasukkan:

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

Anda juga dapat menggunakan variabel lingkungan API_BASE_URL .

Anda sekarang harus dapat terhubung ke admin di http://192.168.12.34:9000 dan itu harus terhubung ke API.

Server Pengembangan

Colmena hadir dengan konfigurasi Docker Compose untuk menjalankan server pengembangan dengan mudah.

Mongodb

Untuk menggunakan MongoDB Server Update local.yaml untuk memasukkan:

 mongodb :
  url : mongodb://localhost/colmena

Anda juga dapat menggunakan variabel lingkungan MONGODB_URL

Mailhog

Untuk menggunakan server mailhog, pembaruan local.yaml untuk memasukkan:

 smtp :
  host : localhost
  port : 1025

Anda juga dapat menggunakan variabel lingkungan SMTP_HOST dan SMTP_PORT

Mulai server

npm run servers # or: npm run servers:start 

Tunjukkan server logging

npm run servers:logs

Hentikan server

npm run servers:stop

Hapus server

npm run servers:rm

Kontributor

Terima kasih kepada orang -orang yang luar biasa ini (Kunci Emoji):

Bram Borggreve ? ? ?	Willian Ribeiro Angelo	Nick Portokallidis	drmikecrowe	Vladimir Mechkauuskas	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

Proyek ini mengikuti spesifikasi semua-kontributor. Kontribusi apa pun yang baik!

Pendukung

Dukung kami dengan sumbangan bulanan dan bantu kami melanjutkan kegiatan kami. [Menjadi pendukung]

Sponsor

Jadilah sponsor dan dapatkan logo Anda di readme kami di GitHub dengan tautan ke situs Anda. [Menjadi sponsor]

Proyek ini sebelumnya dikenal sebagai Loopback Angular Admin.