https://github.com/hyperjumptech/monika-notification-engine
A web app where user can register their WhatsApp phone number to receive notification from Monika
https://github.com/hyperjumptech/monika-notification-engine
Last synced: about 1 year ago
JSON representation
A web app where user can register their WhatsApp phone number to receive notification from Monika
- Host: GitHub
- URL: https://github.com/hyperjumptech/monika-notification-engine
- Owner: hyperjumptech
- Created: 2023-03-10T02:35:14.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-03T22:38:17.000Z (almost 2 years ago)
- Last Synced: 2025-01-20T06:33:00.680Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://whatsapp.hyperjump.tech
- Size: 1.22 MB
- Stars: 0
- Watchers: 6
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Monika Notification Engine
Notification center for Monika users. A web app where user can register their WhatsApp phone number to receive notification from Monika.
## Getting Started
### Prerequisites
- Node.js v^14.14.37
- npm v6.14.11
- PostgreSQL v10
- [Docker](https://www.docker.com/) and [Docker compose](https://docs.docker.com/compose/) (optional)
### Development
Install node package dependencies
```bash
npm ci
```
Copy env file
```bash
cp .env.local.example .env
```
Setup Database
Install and run [PostgreSQL](https://www.postgresql.org/) with credential like in file `docker-compose.yml`
Or
It is easier to use [Docker](https://www.docker.com/) and [Docker compose](https://docs.docker.com/compose/) for development. And run following command in the root project directory:
```bash
docker compose up -d
```
Migrate prisma db
```bash
npm run migrate-db
```
Run on your computer
```bash
npm run dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
### Whatsapp Server
We use [Meta WhatsApp API](https://developers.facebook.com/docs/whatsapp/) to send WhatsApp message. Refer to their docs to learn more.
### Fake Whatsapp Server
To make this app running funtionally, you have to setup a fake server too by doing these steps:
Clone the repo
```bash
git clone https://github.com/ilmiawan/fake-whatsapp-server
```
Then follow the instruction in readme to run the server, and the server will be up in [http://localhost:3030](http://localhost:3030)