Skip to content

ayusclg/notfy-task-backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Notfy Task Backend

A task management API built with Node.js, TypeScript, MongoDB, BullMQ, Redis JWT authentication, and Cloudinary for image handling. It allows users to create tasks and receive smart email reminders exactly at the scheduled time, even if reminders are updated later.

Technologies Used

Node.js

TypeScript

Express

MongoDB & Mongoose

Redis & ioredis

JWT for authentication

BullMQ for job queue and scheduling

Cloudinary for image uploads

Nodemailer for sending emails

Multer for file handling

Nodemon and ts-node for development

Setup Instructions Prerequisites Node.js (v16 or later recommended)

MongoDB instance

Redis server

Cloudinary account (for image handling)

SMTP email service credentials (for sending emails)

Installation

Clone the repository:git clone https://github.com/ayusclg/notfy-task-backend.git

cd notfy-task-backend

Install dependencies:npm install

Environment Variables

Create a .env file in the root directory and add the following environment variables:
  • PORT=3000
  • MONGODB_URI=your_mongodb_connection_string
  • REDIS_URL=your_redis_connection_string
  • JWT_SECRET=your_jwt_secret
  • CLOUDINARY_CLOUD_NAME=your_cloud_name
  • CLOUDINARY_API_KEY=your_api_key
  • CLOUDINARY_API_SECRET=your_api_secret
  • EMAIL_USER=your_email_user
  • EMAIL_PASS=your_email_password
  • Build the project

  • Start the development server with automatic reload:

    npm run build

  • Run the built project:

    npm run start

  • Other source files under src/ for routes, controllers, models, middlewares, and utilities

    About

    No description, website, or topics provided.

    Resources

    Stars

    Watchers

    Forks

    Releases

    No releases published

    Packages

     
     
     

    Contributors