Reddit Notifier

This project is an API to allow reddit users to receive mail notifications every day at 8am.

• There is no UI. It works using REST API calls.
• Uses a JSON file to persist data

Endpoints

User

• Add a new user: POST http://localhost:3000/users
• Get a list of users: GET http://localhost:3000/users
• Get a user: GET http://localhost:3000/users/:id
• Update a user: PUT http://localhost:3000/users/:id
• Delete a user: DELETE http://localhost:3000/users/:id

Channel

• Add a new channel: POST http://localhost:3000/channels
• Get a list of channels: GET http://localhost:3000/channels
• Get a channel: GET http://localhost:3000/channels/:id
• Update a channel: PUT http://localhost:3000/channels/:id
• Delete a channel: DELETE http://localhost:3000/channels/:id

Development server

• Run npm install to install the packages
• Copy .env.example to .env file and fill the reddit info
  • You must follow the first steps on Reddit Quick Start Example and fill the info:
    • REDDIT_CLIENT_ID - app client ID created on reddit
    • REDDIT_CLIENT_SECRET - app client secret
    • REDDIT_DEV_USER - your dev user name
    • REDDIT_DEV_PWD - your dev user password
  • You must get an API key and create a template on Sendgrid to test
    • SENDGRID_API_KEY - API key for sendgrid API
    • SENDGRID_TEMPLATE_ID - sendgrid template ID
    • SENDGRID_DEFAULT_FROM - default email
    • There is a file on root (dynamic-template-sendgrid.html) to import on sendgrid
• Run npm run test:dev for a dev server. the API will be available at http ://localhost:3000/.

Build

Run npm run build to build the project.

Running unit tests

Run npm run test to execute the unit tests.

Dependencies

You will need to have NodeJS 10+ installed globally in your machine.