https://github.com/gaju91/tasker
⎏ NestJs | Typescript microservices template
https://github.com/gaju91/tasker
microservice mongodb nestjs nodejs tcp typeorm
Last synced: 16 days ago
JSON representation
⎏ NestJs | Typescript microservices template
- Host: GitHub
- URL: https://github.com/gaju91/tasker
- Owner: gaju91
- Created: 2023-12-29T07:47:33.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-30T09:39:30.000Z (about 2 years ago)
- Last Synced: 2025-04-14T19:58:30.957Z (12 months ago)
- Topics: microservice, mongodb, nestjs, nodejs, tcp, typeorm
- Language: JavaScript
- Homepage: https://github.com/gaju91/tasker
- Size: 46.9 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🌟 Tasker🌟
## Overview 🎯
Tasker is the central hub 🌐 of our application, seamlessly integrating 🤝 the User and Task Management Microservices. It's crafted to provide a unified interface 🖥️ for managing both tasks 📝 and user data 👥 with ease and efficiency.
## Communication Diagram
## API Reference 📚
**POSTMAN Collection:** [Tasker API Collection](https://github.com/gaju91/tasker/blob/main/API-Docs/postman.collection.js).
Tasker unites two pivotal services:
1. **Tasker HTTP 🧑💼**: Handles all auth and communication with microservices For detailed info, check out the [Tasker HTTP Client Documentation](https://github.com/gaju91/tasker/tree/main/tasker#readme).
2. **User Microservice 🧑💼**: Handles all aspects of user management. For detailed info, check out the [User Microservice Documentation](https://github.com/gaju91/tasker/tree/main/user-ms-v1#readme).
3. **Task Management Microservice 📋**: Manages tasks from creation to completion. Dive into the [Task Management Microservice Documentation](https://github.com/gaju91/tasker/tree/main/task-ms-v1#readme) for more.
### Key Features 🌈
- Unified access point 🚪 to User and Task Management functionalities.
- Simplified interactions 🤹 with a complex microservices architecture.
- Secure handling 🔐 of user sessions and task operations.
### Endpoints Overview 📍
Tasker's endpoints are a mix of functionalities from both the User and Task Management Microservices:
- **User Operations 🧑💼**: Includes user registration, authentication, profile management, and admin functions.
- **Task Operations 📅**: Encompasses task creation, updating, listing, and management with options for filtering and sorting.
### Authentication 🔒
Tasker uses JWT-based authentication for securing endpoints and managing user sessions, ensuring a secure and reliable user experience.
**Default Admin Cred**
This will be created when first time service starts
```bash
DEFAULT_ADMIN_USERNAME=task@admin
DEFAULT_ADMIN_PASSWORD=123456
DEFAULT_ADMIN_EMAIL=tasker.admin@tasker.com
```
## Running Tasker Locally 🏠 🏃♂️
### Prerequisites 📋
- Node.js: Ensure it's [downloaded and installed](https://nodejs.org/).
- Access to both User and Task Management Microservices.
### Steps to Run 🛠️
1. **Clone the Repository**:
```bash
git clone
cd path/to/tasker
```
2. **Install Dependencies**:
```bash
npm install
```
3. **Configure Environment**:
Set up the necessary environment variables to connect to the User and Task Management Microservices.
4. **Launch the Application**:
```bash
npm start
```
## Troubleshooting 🪛
If services doesn't start sometime please clear docker and try again.
```bash
docker compose down
docker container stop $(docker container ls -aq)
docker container rm $(docker container ls -aq)
docker compose up --build
```
## Additional Information 📝
- **Documentation Links** 📖:
- [Tasker HTTP Client Documentation](https://github.com/gaju91/tasker/tree/main/tasker#readme).
- [User Microservice Documentation](https://github.com/gaju91/tasker/tree/main/user-ms-v1#readme)
- [Task Management Microservice Documentation](https://github.com/gaju91/tasker/tree/main/task-ms-v1#readme)