Mobicoop V3 user service
Go to file
Gsk54 4667e57f0c Merge branch 'broker' into 'main'
update readme

See merge request mobicoop/lab/v3/services/user!6
2022-12-22 13:43:19 +00:00
prisma add phone 2022-12-21 16:15:57 +01:00
src send messages on CUD 2022-12-22 14:24:51 +01:00
.dockerignore add prisma 2022-12-13 15:27:28 +01:00
.editorconfig initial commit 2022-12-13 13:39:06 +01:00
.env send messages on CUD 2022-12-22 14:24:51 +01:00
.env.dist send messages on CUD 2022-12-22 14:24:51 +01:00
.eslintrc.js initial commit 2022-12-13 13:39:06 +01:00
.gitignore add prisma 2022-12-13 15:27:28 +01:00
.prettierrc initial commit 2022-12-13 13:39:06 +01:00
Dockerfile add prisma 2022-12-13 15:27:28 +01:00
LICENSE initial commit 2022-12-13 13:39:06 +01:00
README.md update readme 2022-12-22 14:42:47 +01:00
docker-compose.yml fix dockerization 2022-12-15 17:14:50 +01:00
jest-e2e.json initial commit 2022-12-13 13:39:06 +01:00
nest-cli.json prsima, grpc 2022-12-13 18:00:07 +01:00
package-lock.json send messages on CUD 2022-12-22 14:24:51 +01:00
package.json send messages on CUD 2022-12-22 14:24:51 +01:00
tsconfig.build.json initial commit 2022-12-13 13:39:06 +01:00
tsconfig.json initial commit 2022-12-13 13:39:06 +01:00

README.md

Mobicoop V3 - User Service

User-related data management.

Requirements

You need Docker and Docker-compose.

A RabbitMQ instance is also required to send messages when data has been inserted/updated/deleted.

Installation

Copy .env.dist to .env :

cp .env.dist .env

and modify it to suit your needs.

Then execute :

docker-compose up -d

The app runs automatically on the port defined in SERVICE_PORT of .env file (default : 5001).

You then need to set the appropriate rights for PGAdmin container :

sudo chown -R 5050:5050 postgresql/.pgadmin_data

Database migration

Before using the app, you need to launch the database migration :

docker exec v3-user sh -c "npx prisma migrate dev"

Usage

The app exposes the following gRPC services :

  • FindByUuid : find a user by its uuid

    {
        "uuid": "80126a61-d128-4f96-afdb-92e33c75a3e1"
    }
    
  • FindAll : find all users; you can use pagination with page (default:1) and perPage (default:10)

    {
        "page": 1,
        "perPage": 10
    }
    
  • Create : create a user (note that uuid is optional, a uuid will be automatically attributed if it is not provided)

    {
        "email": "jezabel.doe@email.com",
        "firstName": "Jezabel",
        "lastName": "Doe"
    }
    
  • Update : update a user

    {
        "firstName": "Jezabel-Katarina",
        "email": "jezabel-katarina.doe@email.com",
        "uuid": "30f49838-3f24-42bb-a489-8ffb480173ae"
    }
    
  • Delete : delete a user by its uuid

    {
        "uuid": "80126a61-d128-4f96-afdb-92e33c75a3e1"
    }
    

Messages

A mentionned earlier, RabbitMQ messages are sent after these events :

  • Create (message : the created user informations)

  • Update (message : the updated user informations)

  • Delete (message : the uuid of the deleted user)

Test

# unit tests
docker exec v3-user sh -c "npm run test"

# test coverage
docker exec v3-user sh -c "npm run test:cov"

Note : you can run all npm commands directly outside the container (see scripts section of package.json for available commands), but you need NodeJS installed locally. We strongly advise to install Node Version Manager and use the latest LTS version of Node.

License

Mobicoop V3 - User Service is AGPL licensed.