books-backend

This repository contains the backend logic that powers the Books platform via a RESTful API.

Note that this document is still in WIP, thus some information might be missed or not up to date.

Table of contents

• Installation
• How to run
• How to test
• Documentation
• CI/CD Pipeline
• Authors

Installation

Before proceeding with the installation, you will need the following software:

• NodeJS
• MongoDB

In order to install this application you will need to use the following commands:

git clone https://gitlab.inf.unibz.it/Riccardo.Busetti/books-backend.git
git checkout [branch-name]
npm install

Last but not least, put a .env file in the root folder, containing the following:

APP_NAME=[The name of the app]
PORT=[The port where to listen for http request]
MONGO_DB_URL=[The database url for mongo db]
SECRET_KEY=[The secret key used to encrypt jwt tokens]
ENABLE_LOGGING=[The boolean value representing if you want or not to enable logging]
CLOUDINARY_URL=[The url of the cloudinary store]
GCP_API_KEY=[The API key for the Google Cloud Platform]
SELL_BOOK_CONFIRM_BASE_URL=[The base url for the confirming of a sell (e.g. the frontend url)]

How to run

Execute:

npm run dev

How to test

Execute:

npm test

Documentation

Start the server and go to /api-docs endpoint or open the file /assets/openapi.json on GitLab.

CI/CD Pipeline

The report for the CI/CD pipeline can be found here.

Authors

• Riccardo Busetti
• Gioele De Vitti