https://github.com/clovisdasilvaneto/yara-stock-service

https://github.com/clovisdasilvaneto/yara-stock-service

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/clovisdasilvaneto/yara-stock-service
• Owner: clovisdasilvaneto
• Created: 2024-02-17T23:28:35.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-02-20T12:01:02.000Z (9 months ago)
• Last Synced: 2024-02-21T12:37:37.416Z (9 months ago)
• Language: TypeScript
• Size: 559 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Yara Stock Service

This is the service for managing yara warehouses and products of a given client. You can find a detailed diagram about how it works and what is the database modeling behind it by [clicking here](https://excalidraw.com/#json=5Q7IYSqHkzG5wYdwFWFef,LOQuzSuH0RqudjMNmjLVEg) or looking to this image bellow: 

![Yara Warehouse Diagram Image](diagram.png) 

You can find the GraphQL API playground here: https://yara-stock-service.onrender.com/graphql

If you run to run the service locally, you can follow these instructions bellow.

## Installation

```bash

$ npm install

```

## Running the app

```bash

# development

$ npm run start

# watch mode

$ npm run start:dev

# production mode

$ npm run start:prod

```

## Test

```bash

# unit tests

$ npm run test

# e2e tests

$ npm run test:e2e

# test coverage

$ npm run test:cov

```

## TODO - Nice to have:

- SEED

- TRANSACTIONS

- MIGRATIONS

- VALIDATIONS FACTORY