TKK_E32232188/smartcollar-be
Hilmania Zahra f09a282153 Initial commit 2026-07-20 16:21:52 +07:00
..
src Initial commit 2026-07-20 16:21:52 +07:00
.env.example Initial commit 2026-07-20 16:21:52 +07:00
.gitignore Initial commit 2026-07-20 16:21:52 +07:00
CHANGELOG.md Initial commit 2026-07-20 16:21:52 +07:00
CONTRIBUTING.md Initial commit 2026-07-20 16:21:52 +07:00
README.md Initial commit 2026-07-20 16:21:52 +07:00
package-lock.json Initial commit 2026-07-20 16:21:52 +07:00
package.json Initial commit 2026-07-20 16:21:52 +07:00

README.md

Smart Collar Backend

Backend API untuk sistem Smart Collar, sebuah platform IoT yang digunakan untuk monitoring kesehatan dan aktivitas ternak secara real-time menggunakan perangkat Smart Collar berbasis ESP32.

Features

  • Firebase Authentication
  • Cow Management
  • Smart Collar Management
  • Assignment Management
  • Real-time Monitoring
  • WhatsApp Notification (Fonte)
  • REST API
  • Firebase Realtime Database

Tech Stack

  • Node.js
  • Express.js
  • Firebase Admin SDK
  • Firebase Realtime Database
  • Firebase Authentication
  • Zod
  • JWT
  • Fonte API
  • ES Modules

Project Structure

src
├── config
├── core
├── middlewares
├── modules
│   ├── auth
│   ├── cow
│   ├── collar
│   ├── assignment
│   ├── monitoring
│   ├── notification
│   └── settings
├── routes
├── shared
├── app.js
└── server.js

Installation

Clone repository.

git clone <repository-url>

Install dependencies.

npm install

Copy environment file.

cp .env.example .env

Run development server.

npm run dev

Run production server.

npm start

Environment Variables

See .env.example.

API Version

Current Version:

v1

Development Workflow

  • Create feature branch from develop
  • Implement feature
  • Test locally
  • Commit using Conventional Commits
  • Open Pull Request into develop
  • Merge into main only after testing

Roadmap

  • Authentication
  • Cow Management
  • Smart Collar Management
  • Assignment Module
  • Monitoring Module
  • WhatsApp Notification
  • Dashboard & Analytics
  • OTA Firmware Support

License

This project is licensed under the MIT License.