Description

Zack is an application that allows you to create schedules and send emails based on a specified date and time. With this service, you can easily manage schedules and automate email notifications at the right moment.

Tecnologies

• Node.js
• Express
• Typescript
• Vercel

Installation Guide for Developers

Download and Install Git:

1. Ensure Git is installed on your machine. You can download it from Git's official website.

Download and Install Node.js:

1. Make sure Node.js is installed on your machine. You can download it from Node.js official website.

Clone the Repository:

1. Open the terminal, and execute the next command:

 git clone https://github.com/dreamcityteam/Zack.git

 cd Zack

Setup Environment Variables:

1. Contact the developers to obtain the .env file.
2. Add the .env file in the root directory of the project.

Run the Application in mode development:

1. Open the terminal at the root of the project and execute the following command: npm i && npm run start:dev

API Endpoints

GET /api/v1/schedules

Retrieve all the schedules added to the system.

URL:

https://zack-ivory.vercel.app/api/v1/schedules?token=XXXX

Parameters:

token (required): Authentication token for the request.

Response:

Success:

{
  "data": {
    "12/26/2024": {
      "12:50": {
        "[email protected]": true
      }
    },
   "01/08/2025": {
      "08:29": {
        "[email protected]": true,
        "[email protected]": true
      }
    },
  },
  "message": "Successfuly",
  "status": 200
}

POST /api/v1/schedules

Add a new schedule to the system. This endpoint will also trigger an email to be sent based on the schedule.

URL:

https://zack-ivory.vercel.app/api/v1/schedules?token=XXXX

Parameters:

token (required): Authentication token for the request.

Payload (JSON):

{
  "schedule": "12:50",   // The time when the email should be sent
  "date": "12/26/2024",  // The date of the schedule
  "email": "[email protected]"  // Recipient email address
}

Response:

Success:

{
  "data": {
    "12/26/2024": {
      "12:50": {
        "[email protected]": true
      }
    },
  },
  "message": "Successfuly",
  "status": 200
}

Error:

{
  "data": null,
  "message": "The date is in the past.",
  "status": 400
}

License:

This project is licensed under the MIT License.

Contact:

For any questions, feel free to reach out to the development:

Email: [email protected]
WhatsApp: +1 (829) 683-2226