RentRipple Backend

Prerequisites

• Docker
• Git

Setup (Local)

# Get repository
$ git clone https://github.com/RentRipple/RentRipple-Backend.git & cd RentRipple-Backend/

# Run application
$ npm install

$ run redis and mongoDB first

$ npm run start

App will run on http://127.0.0.1:6000

Setup (prod)

# Get repository
$ git clone https://github.com/RentRipple/RentRipple-Backend.git && cd RentRipple-Backend/

# Run application
$ docker-compose up --build

Redis

To run redis cli
$ docker exec -it rentripple-backend-redis-1 redis-cli

MongoDB

To run MongoDB cli
$ docker exec -it rentripple-backend-mongo-1 mongosh

Parameter	Example
myapp	localhost:8000
redis	localhost:6379
mongodb	localhost:27017

API Endpoints Documents

$ Get
$ curl http://{environment}//api-docs
$ # Example
$ curl http://localhost:8000/api-docs