A lightweight RESTful API that provides comprehensive user management (CRUD). The service supports:
- User registration and login
- User profile management
- Handling and storing user photos
- Transferring funds between users
- Sending notifications to users
- Resetting all users’ balances
Stack: Node.js, NestJS, HTTP, WebSocket, NATS, Prisma, PostgreSQL, MiniO, Redis, BullMQ, Docker, Docker Compose
- Clone the repository.
git clone git@github.com:nikj01/people.git- Install dependencies using yarn.
yarn install- Run docker-compose file using Podman or Docker.
podman-compose up -dCreate a .env file in the project's root directory and add your environment variables. You can use the .env.example file for reference. Note that some variables must be replaced with your own values. For example, using MinIO, you need to create access and secret keys, as well as a bucket named main in your MinIO instance, and add them to the .env file. Otherwise, the application will not start.
- Run the database migrations and insert the seed data.
yarn setup:db- Now you’re all set up and ready to run the application. By default, the app listens on port 35505 and the notification service on port 35506. You can modify these settings in the
.envfile.
nest start people
nest start notification-service- You can find the API documentation at
http://localhost:35505/swagger/#. The documentation is generated using Swagger and provides detailed information about the available endpoints, request/response formats, and authentication methods.