vivia1990/univr-img-catalog-server

Progetto ingegneria del Software 2022/2023

Catalog App

Getting Started

Follow these instructions to get the project up and running.

Prerequisites

• Node.js >= 20 installed (or nix)

Installation

1. Clone the repository:

   git clone https://github.com/your-username/your-project.git 

2. Cd into the folder Install dependencies:

       npm install --no-package-lock # installs yarn
       yarn

3. Compile the project to dist/

       yarn build

4. Run the related services (mongodb)

       docker compose up -d # to build the containers
       docker compose start # if you have already built the containers

5. Init the db

       yarn db-init

6. Run the server

       yarn express

Server

The server will be running at http://localhost:PORT You must replace PORT with the one in the .env file.

.env

Copy the versioned .env.example file to .env, and change it accordingly

Test

Test are based on builtin Node's testing suite (starting from node 20)
Run with:

1. Build the test

   yarn build-test # build the test

2. Run the related services (mongodb)

       docker compose up -d # to build the containers
       docker compose start # if you have already built the containers

3. Run the tests:

    yarn run-test {args} dist-test/{path_to_folder}
    
    # or build and run
   yarn test {args} dist-test/{path_to_folder}

By Default all file named Test will be run