A backend service built with TypeScript. It includes full CRUD for users, admins, and all relevant entities. It also manages notifications (in-app and email) for both user types. The project includes RESTful endpoints, environment management, and code formatting.
.
├── .husky/ # Git hooks for pre-commit checks
├── .vscode/ # VS Code workspace settings
├── public/ # Public assets (if any)
├── src/ # Source code (controllers, routes, services, etc.)
├── .env.example # Example environment variables
├── Dockerfile # Docker configuration
├── eslint.config.mjs # ESLint configuration
├── nodemon.json # Nodemon settings for dev
├── package.json # Project metadata and scripts
├── tsconfig.json # TypeScript configuration
└── ...
- Send email and in-app alerts
- Endpoints for Admin, User, WaterTank, Feed, Measurement, and more
- A scheduler that fetches all measurements of a water tank each night and sends the data to an AI agent to generate reports
- And much more
git clone https://github.com/your-username/your-repo-name.git
cd your-repo-namenpm installCreate your .env file based on the example:
cp .env.example .envEdit .env with your configuration.
npm run dev- Create Alert: API endpoint to send an in-app notification
- Send Email: API endpoint to send emails using SMTP credentials
APIs are defined inside the src/ directory.
npm run dev # Start development server
npm run build # Build project (TypeScript to JS)- ✅ ESLint:
.eslint.config.mjs - 🎨 Prettier:
.prettierrc - 🧼 Git Hooks via Husky:
.husky/
Run manually:
npm run lint
npm run format- Swagger is available at
/api-docs, though it’s worth noting that it wasn’t fully completed.