README.md

User hierarchy application

How to Run the application and the tests

Requirements

• Docker and Docker Compose installed in the machine

Run the tests

make test

Run the application

make dev

Open in the browser URL: http://localhost:3000/api-docs

CI / CD

Application is built using CircleCI and deployed in heroku

Important files

server
    api
        controllers      
            user-roles
                controller.ts       // Main controller to handle incoming requests
        common
            api.yml                 // API definition, API is validate based on this file
        services         
            user.service.ts         // main service with all logic regarding hierarchy
            user.service.test.ts    // tests for the service

Technologies / Libraries

• Node - JS runtime environment
• Expressjs - web framework for Node.js
• Yarn - package manager
• TypeScript - Typed superset of javascript that compiles to plain javascript
• ESLint - Lint tool for TypeScript
• Swagger - API documentation and validation
• Jest - Test Suite