An open API service indexing awesome lists of open source software.

https://github.com/rminelli/airbus-technical-assignment

Sun Spot Analyser Test
https://github.com/rminelli/airbus-technical-assignment

Last synced: 3 months ago
JSON representation

Sun Spot Analyser Test

Awesome Lists containing this project

README

        

## Main technologies with which this project was developed:

- NodeJS
- NestJS
- PostgreSQL

## Installation

```bash
$ npm install
```

## Running with docker

```bash
# Docker with all services
$ docker compose -f "docker-compose.yml" up -d --build

# Docker with only the database
$ docker compose -f "docker-compose.dev.yml" up -d --build

```

## Running the app

```bash
# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod
```

## API

```bash

# API url
$ http://localhost:3001/

# API Documentation with Swagger
$ http://localhost:3001/api

# Project documentation (only at the development level, outside of docker)
$ http://localhost:8080

```

## Test

```bash
# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov
```

## Documentation

```bash
# Create code documentation
$ npm run doc
```