https://github.com/carlostojal/vcard_notifications

Notification service.
https://github.com/carlostojal/vcard_notifications

Last synced: 2 days ago
JSON representation

Notification service.

• Host: GitHub
• URL: https://github.com/carlostojal/vcard_notifications
• Owner: carlostojal
• Created: 2023-11-05T13:27:50.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-19T07:56:23.000Z (11 months ago)
• Last Synced: 2024-10-12T19:53:30.255Z (about 1 month ago)
• Language: JavaScript
• Size: 91.8 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# vCard Notification Service

This service uses WebSocket to dispatch notification to the Vue.js clients.

## Authentication

This service does nothing special about authentication. In fact, it must not be trusted at all. A JWT with a symmetric key is used, which contains the user ID. The payload of the JWT just looks like this:

```json

{

  "sub": "0987654321"

}

```

## Running

First, you need to setup the app by creating a `.env` file. Create a copy of the `.env.example` file and make your own changes.

### Bare metal

- Run `npm install`;

- Run `npm start`.

### Docker

- Run `docker build -t vcard_notifications .`;

- Run `docker run vcard_notifications`.