Getting Started
Welcome to the Uniconnect engineering team! This guide provides the initial prerequisites and access required to get up and running across the Uniconnect platform repositories.
1. Prerequisites
Ensure you have the following installed on your local machine:
- Node.js: v20.x or v22.x LTS
- npm (v10+) or pnpm
- Docker & Docker Desktop: For local PostgreSQL, Redis, and services
- Git: Configured with your corporate GitHub account
- Postman / Bruno / Insomnia: For API testing
2. Core Repositories
Uniconnect Enterprise is divided into focused repositories:
| Repository | Purpose | Primary Stack |
|---|---|---|
| uc-enterprise-core | Backend API & microservices engine | Node.js, Moleculer.js, Prisma, PostgreSQL |
| uc-enterprise-web | Frontend web application portal | React, TypeScript, Redux Toolkit, Vite |
| uc-enterprise-cube | Real-time & analytical reporting engine | Cube.js, PostgreSQL |
| 3cx-api-wrapper | Telephony bridge & PBX socket service | Node.js, TCP Sockets, 3CX Call Control API |
| uc-mock-3cx | Mock PBX service for local dev/testing | Node.js, Mock Sockets |
3. GitHub Organization Access
Request access to the Uniconnect-io GitHub organization:
- Ensure 2-Factor Authentication (2FA) is enabled on your GitHub account.
- You will be added to the appropriate engineering team (Core, Web, Platform).