It's forked from https://github.com/Giveth/apiGive

Notification Center

This is a microservice for managing notifications for both https://giveth.io and other Dapps notifications

Used Technologies

Installation

Test

Logs

Migrations

References

Used_Technologies

• Nodejs v16 (You can use nvm use command to load appropriate Node version by nvm)
• Typescript v4.5.2
• DB: postgres v14.2
• DB ORM: TypeORM v0.3.6
• Redis v5.0.9
• API protocol : REST
• Web application: Express v4.17.3
• Deployment: docker-compose v3.3
• API Documentation: Swagger
• Test framework: Mocha v9.2.2
• CI/CD tools : GitHub Actions

Installation and Run

• git clone [email protected]:Giveth/notification-center.git
• cd notification-center
• npm ci
• Bringing up database, you can install that in other way, but I suggest using docker docker-compose -f docker-compose-local-postgres-redis.ym up -d
• Creat a file named development.env based on Env example file and put it in ./config
• Run Migrations
• npm start
• Now you can browse Swagger

Test

You should have a postgress instance up in order to running tests so you can use Local DB docker-compose

• npm run test

Logs

In localhost and test we put logs in console and file but in production and staging we just use file for writing logs You can see logs beautifully with this command

• npm i -g bunyan
• tail -f logs/notification-center.log | bunyan

Migrations

Create new Migration file

typeorm migration:create ./migrations/createNotificationTable

Then you need to run the migrations like so

npm run db:migrate:run:local

If you want to revert last migration

npm run db:migrate:revert:local

Create Third party in DB

As we can't put inserting third parties in migration, I put a query sample here, we can use it in prod

  INSERT INTO public.third_party(
  "microService", secret, "isActive")
  VALUES ('givethio', 'givethio_secret', true);

Local test

If you use mock jwt authentication adapter you can use accessToken

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwdWJsaWNBZGRyZXNzIjoiMHgxMUJFNTVGNGVBNDFFOTlBM2ZiMDZBRGRBNTA3ZDk5ZDdiYjBhNTcxIiwiZXhwaXJhdGlvbkRhdGUiOiIyMDIyLTA5LTIzVDA4OjA5OjA2LjQ1N1oiLCJqdGkiOiIxNjYxMzI4NTQ2NDU3LTc1YzNhNGI2YWUiLCJpYXQiOjE2NjEzMjg1NDYsImV4cCI6MTY2MzkyMDU0Nn0.Tdd2f7bCMtg3F1ojX1AQQpJ7smTU7vR7Nixromr0ju4

References

I used these articles for writing project

• https://blog.logrocket.com/linting-typescript-using-eslint-and-prettier

• https://rsbh.dev/blog/rest-api-with-express-typescript