colmena

 Free and Open Source 
Full Stack
RAPID API DEVELOPMENT

ขับเคลื่อนโดย loopback และ Angular

เกี่ยวกับ

Colmena เป็นชุดเริ่มต้นสำหรับ API ที่มีอินเทอร์เฟซผู้ดูแลระบบที่สามารถขยายและสร้างได้อย่างง่ายดาย

มันถูกสร้างขึ้นโดยใช้ชุดของโครงการโอเพนซอร์สที่ยอดเยี่ยมรวมถึง แต่ไม่ จำกัด เพียง:

• Loopback - API Server ขึ้นอยู่กับ Express
• Angular - MVC Framework เพื่อสร้างเว็บแอป
• Loopback SDK Builder - การบูรณาการที่ยอดเยี่ยมของ Loopback และ Angular
• CoreUi - เทมเพลตผู้ดูแลระบบ Bootstrap ที่น่าทึ่ง

คำเตือน

ซอฟต์แวร์นี้อยู่ระหว่างการพัฒนาที่ใช้งานอยู่!

โปรดอย่าใช้มันในการผลิตโดยไม่ต้องระบุปัญหาในส่วนงานระหว่างดำเนินการ

ทำงานระหว่างดำเนินการ

Colmena เป็นงานที่อยู่ระหว่างดำเนินการและยังไม่ได้สร้างฟังก์ชั่นทั้งหมด

• มีการใช้งาน ACL พื้นฐานเท่านั้นซึ่งหมายความว่า API สามารถใช้งานได้โดยใครก็ตามที่สามารถเข้าถึงได้
• อินเทอร์เฟซไม่ได้สะท้อนบทบาทของผู้ใช้ (ผู้ดูแลระบบ/ผู้จัดการ/ผู้ใช้)
• เนื้อหาจะรั่วไหลผ่านโดเมนในขณะที่ไม่ควรเป็นไปไม่ได้

โครงสร้าง

โครงการนี้เป็นโมโนรีเป้ที่จัดการโดย Lerna มันมีโครงสร้างเช่นนี้:

• apps/
  • admin อินเทอร์เฟซผู้ดูแลระบบที่สร้างขึ้นด้วย Angular
  • api REST API สร้างขึ้นด้วย loopback
• modules/
  • admin-* โมดูลที่เพิ่มฟังก์ชันการทำงานให้กับแอพผู้ดูแลระบบ
  • โมดูล api-* ที่เพิ่มฟังก์ชันการทำงานให้กับแอป API
• packages/
  • admin-* แพ็คเกจที่ใช้โดยแอพผู้ดูแลระบบ
  • api-* แพ็คเกจที่ใช้โดยแอป API

โครงสร้างของโครงการนี้ได้รับแรงบันดาลใจจากตัวอย่างที่ยอดเยี่ยมนี้: Oasisdigital/Scalable-Enterprise-Angular

การติดตั้ง

ความต้องการ

ซอฟต์แวร์ที่ติดตั้งในระบบของคุณ:

• node (v6.9.x หรือสูงกว่า)
• npm (v3.x หรือสูงกว่า)

แพ็คเกจโหนดที่ติดตั้งทั่วโลก:

• CLI เชิงมุม
• เลิร์นนา
• 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

URL ฐาน API

โดยค่าเริ่มต้นสแต็กการพัฒนาจะถือว่า API และผู้ดูแลระบบเริ่มต้นใน LocalHost (ใช้ 127.0.0.1 )

เพื่อที่จะเรียกใช้ API บนโฮสต์อื่นนอกเหนือจาก localhost ผู้ดูแลระบบจำเป็นต้องรู้ว่าที่อยู่ IP ใดที่สามารถเข้าถึง API ในการทำเช่นนี้คุณต้องอัปเดตคุณสมบัติการกำหนดค่า api.baseUrl

ตรวจสอบให้แน่ใจว่าได้กำหนดค่า URL ฐาน API โดยไม่ต้อง สแลชต่อท้าย

ในการตั้งค่า URL URL Base UND 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 สำหรับการเรียกใช้เซิร์ฟเวอร์การพัฒนาได้อย่างง่ายดาย

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 - - -	Willian Ribeiro Angelo	Nick Portokallidis	drmikecrowe	Vladimir Mechkauskas	Bernardo Arevalo	ยิว
Brian McIntyre	Rob Halff	Asgeir Birkisson	DTHIB	Oleh Kukil	Pulkit Singhal	Tuan PM
คนบราวน์	hoàngphúc	Brian Dunnette	เชนซิน	Tersius Kuhne	Alex Quiambao	José Luis di Biase
Shing.	อเล็กซ์ไวลด์	DMTW	มาร์คัส	Brannon N. Darby II	Sebastian Podgajny	Iscaster

โครงการนี้เป็นไปตามข้อกำหนดทั้งหมดของผู้เข้าร่วม การมีส่วนร่วมทุกชนิดยินดีต้อนรับ!

ผู้สนับสนุน

สนับสนุนเราด้วยการบริจาครายเดือนและช่วยให้เราดำเนินกิจกรรมต่อไป [เป็นผู้สนับสนุน]

ผู้สนับสนุน

เป็นสปอนเซอร์และรับโลโก้ของคุณบน readme ของเราบน GitHub พร้อมลิงค์ไปยังเว็บไซต์ของคุณ [เป็นสปอนเซอร์]

โครงการนี้เคยเป็นที่รู้จักกันในชื่อ Loopback Angular Admin