Locstream Backend is a scalable server-side application built with NestJS and TypeScript. It provides core APIs and real-time features for location streaming, user management, authentication, and asset handling. The backend is designed for extensibility and security, leveraging PostgreSQL, TypeORM, JWT authentication, and WebSockets.
- User authentication and authorization (JWT)
- Admin and privileged user roles
- Asset management (CRUD)
- Real-time location sharing via WebSockets
- PostgreSQL database integration (TypeORM)
- Cloudinary integration for asset storage
- Modular architecture for easy feature extension
- Centralized exception handling and validation
- NestJS (TypeScript)
- TypeORM (PostgreSQL)
- Socket.IO (WebSockets)
- Cloudinary (Asset storage)
- JWT (Authentication)
- ESLint & Prettier (Code quality)
- Jest (Testing)
Clone the repository and install dependencies:
Locstream Backend is a scalable server-side application built with NestJS and TypeScript. It provides core APIs and real-time features for location streaming, user management, authentication, and asset handling. The backend is designed for extensibility and security, leveraging PostgreSQL, TypeORM, JWT authentication, and WebSockets.
- User authentication and authorization (JWT)
- Admin and privileged user roles
- Asset management (CRUD)
- Real-time location sharing via WebSockets
- PostgreSQL database integration (TypeORM)
- Cloudinary integration for asset storage
- Modular architecture for easy feature extension
- Centralized exception handling and validation
- NestJS (TypeScript)
- TypeORM (PostgreSQL)
- Socket.IO (WebSockets)
- Cloudinary (Asset storage)
- JWT (Authentication)
- ESLint & Prettier (Code quality)
- Jest (Testing)
Clone the repository and install dependencies:
git clone https://github.com/bilalmbaka/locstream.git
cd locstream/locstream-backend
npm install
git clone https://github.com/bilalmbaka/locstream.git
cd locstream/locstream-backend
npm install# development
npm run start
npm run start
# watch mode
npm run start:dev
npm run start:dev
# production mode
npm run start:prod
npm run start:prod# unit tests
npm run test
npm run test
# e2e tests
npm run test:e2e
npm run test:e2e
# test coverage
npm run test:cov
npm run test:covDeploy using your preferred cloud provider or containerization platform. For more details, see NestJS deployment docs.
Contributions are welcome! Please fork the repository and submit a pull request. For major changes, open an issue first to discuss what you would like to change.
This project is open source and may be cloned, used, and modified by anyone for any purpose. No restrictions are imposed on usage or modification. This project is open source and may be cloned, used, and modified by anyone for any purpose. No restrictions are imposed on usage or modification.