user-microservice-project

The app targets node 18.7.0
link to API documentation on postman here: https://documenter.getpostman.com/view/25777649/2sA3duGZ3e

Start here

To use the app, you would need mongodb, nodejs and npm installed.
Both frontend, backend and database are run concurrently.

How to set up MongoDB

Install mongodb on your machine.
Refer to the www.mongodb.com for instructions on installation for your operation system. Afterwards, start the mongod service in your cmd.

How to set up Nodejs

Install nodejs from nodejs.org. Likewise, follow the instructions for your operating system.

Installation of nodejs and npm on different Operating Systems

windows

Install using the link above and follow the instructions.

macOS

Install nodejs and npm using Homebrew. Open the terminal and run;

    brew install node

Linux

Use apt to install nodejs and npm. In the terminal run;

    sudo apt update
    sudo apt install nodejs npm

Testing of the endpoints in the backend

Move to the Backend folder and run:

    npm run test

Steps to run project

1. Clone the Repository

    git clone https:/Lonercode/user-microservice-project.git
    cd user-microservice-project

2. Backend Setup

    cd Backend
    npm install

3. Frontend Setup

    cd ../Frontend
    npm install

4. Environment variables

Create a .env file using the .env.example file as a guide. Create your PORT and DB_URI env variables depending on your setup.

5. Concurrency Usage (Project setup)

In the root of the project, run the follwing code:

    npm install

6. Start the Application

Start both backend and frontend servers concurrentlty. In the root of the project run:

    npm run start