Description

Puente's Email and SMS API built using Node.js and NestJS.

Installation

$ npm install

Running the app

Start Commands

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test Commands

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Project Structure

Modules

The architectural design of NestJS encourages feature modules. This feature-based design groups the functionality of a single feature in one folder, registered in one module. This design simplifies the codebase and makes code-splitting very easy.

Email

POST Call Structure to "http://{{ROOT_UTL}}/email

{
    "emailSubject": "Email Subject",
    "objectId":"User's Parse ObjectId",
    "userFullName":"User's Fullname",
    "emailsToSendTo":[
        "usersemail@email.com"
    ],
    "type":"passwordReset"
}

Text

POST Call Structure to "http://{{ROOT_UTL}}/email

{
    "textTo": "1234567",
    "textBody": "Text"
}

Services

Services are classes that handle business logic.

• Mailchimp
• Twilio

Resources

Nest framework TypeScript starter repository.