This project consist of an API developed using NodeJS which returns a list of users and collection of roles and users, given a user Id returns a list of ALL their subordinates (i.e.: including their subordinate's subordinates). The front end of this project is developed in ReactJS that is consuming NodeJS API.
This repossitory consists of two folders api and client. The api is the NodeJS application that is serving as a backend server side hosting APIs consumed by the client which is a ReactJS application.
Please follow the instructions sequentially:
- Make sure you have the right version of Node which is v12.16.2
- Also make sure you have NPM and Yarn installed
- Clone this repository
- Navigate to
apifolder - run
sudo chmod +x ./start-server.shwhich will make./start-server.shscript executable - Now run
./start-server.shwhich will start the server up onlocalhost:9000after installing all the dependencies and running API tests - Now in a different tab of terminal or a new window, navigate to
clientfolder - run
sudo chmod +x ./start-react.shwhich will make./start-react.shscript executable - Now run
./start-react.shwhich will start the server up onlocalhost:3000after installing all the dependencies - Navigate to
localhost:3000to see the application in action
- There are only two APIs that is consumed by react application which are as follows:
- GET localhost:9000 (returns JSON array of all users)
- GET localhost:9000/subordinates?user_id={int} (returns all the subordinate and it's subordinate's subordinates as a JSON array)
- All the logic for the users-role-hierarchy sits inside
api/services/UserRolesService.js - The input object of users and roles is passed in
api/routes/usersHierarchy.js, which can be changed - For running API tests, navigate to
apiand runnpm run test
- git
- Node v12.16.2
- NPM v6.14.4
- Yarn v1.12.3
- React v16.13.1
- ExpressJS Framework for NodeJS