https://github.com/jhotika/notification-framework-example-mongo

https://github.com/jhotika/notification-framework-example-mongo

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/jhotika/notification-framework-example-mongo
• Owner: Jhotika
• Created: 2025-01-19T08:34:08.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2025-01-20T20:09:30.000Z (5 months ago)
• Last Synced: 2025-04-16T01:57:32.860Z (about 2 months ago)
• Language: TypeScript
• Size: 263 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Notification Framework Example With Mongo

Documentation on how to make the notification framework up and running with nodejs project

### Project structure

The example repository follows mono-repo architecture where frontend(FE), backend(BE) and all other directories are stored as a single codebase.

### FE - Front end

NextJs project. Can be anything depending on project requirements. 

### CommonTs

A shared folder between backend and frontend. This is optional. We use this to reduce code duplication between frontend and backend.

### BE - Back end

NodeJS project. This is where our notification framework will live. 

### Installing dependencies

Run ```npm install``` in both FE and BE.

### Clone the notification framework

Clone the notification framework in using 

```bash

git clone https://github.com/Jhotika/notification-framework.git

```