ammar/backend
1
0
Fork 0
mirror of https://github.com/SyncrowIOT/backend.git synced 2025-07-14 18:05:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'dev' into SP-169-be-create-space-and-space-types

Browse Source
This commit is contained in:
faris Aljohari
2024-04-29 14:14:58 +03:00
parent 9e40cdb0ed e078178f80
commit 4ff343294a
1 changed files with 70 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
README.md
View File

@ -1,8 +1,27 @@
# Backend
## Description
## Overview
This is the backend for an IoT application built using NestJS. It interfaces with the Tuya IoT cloud platform to manage homes, rooms, devices, ...etc.
This is the backend APIs project, developed with NestJS for Syncrow IOT Project.
## Database Model
The database uses PostgreSQL and TypeORM. Below is an entity relationship diagram:
The main entities are:
User - Stores user account information
Home - Represents a home/space
Room - Represents a room/sub-space
Device - Represents a connected device
Product - Stores metadata about device products
Other Entities - sessions, OTPs, etc.
The entities have a one-to-many relationship - a user has multiple homes, a home has multiple rooms, and a room has multiple devices.
## Architecture
The application is deployed on Azure App Service using Docker containers. There are separate deployment slots for development, staging, and production environments.
## Installation
First, ensure that you have Node.js `v20.11` or newer (LTS ONLY) installed on your system.
@ -38,3 +57,53 @@ $ npm run test:e2e
$ npm run test:cov
```
## ERD Diagram
![Syncrow ERD Digram](https://github.com/SyncrowIOT/backend/assets/83524184/94273a2b-625c-4a34-9cd4-fb14415ce884)
## Architecture
+----------------------------------+
| |
| Applications |
| |
+-----------------------------+-------------+--------------------+
| | |
| | API Calls |
| | |
| v |
| +---------------------+------------------------+ |
| | | | |
| | Dev Slot | Staging Slot | |
| | | | |
| +---------------------+------------------------+ |
| | | |
| | | |
| | | |
| +------------------+ +---------------------+ |
| | Dev Database | | Staging Database | |
| +------------------+ +---------------------+ |
| |
| +-----------------------------------------+ |
| | | |
| | Production | |
| | | |
| +-----------------------------------------+ |
| | | |
| | | |
| | | |
| +------------------+ | |
| | Production DB | | |
| | Highly Available | | |
| | Cluster | | |
| +------------------+----------------+ |
| | Production DB | | |
| | Standby Node | | |
| +------------------+ | |
| | Production DB | | |
| | Standby Node | | |
| +------------------+ | |
| | Production DB | | |
| | Standby Node | | |
| +------------------+----------------+ |
+-----------------------------------------------------------------+