Store backend

Description

This project is a web application for a store management system. The application is the backend of the store system and is responsible for the API that will be consumed by the frontend. The application is developed using NestJS, a framework for building efficient, reliable and scalable server-side applications.

Setup

Prerequisites

Dependencies

The first step have been installed node and npm or yarn in your machine. After that you need to install the package manager with yarn running the command bellow:

npm install -g yarn

Then you can install the project dependencies running the command bellow:

yarn

Environment

Database

The project uses a PostgreSQL database. You can use a docker desktop to run the database with docker compose the command bellow:

docker compose up -d

Or if you wanna use an alternative you can use podman to run the database container, you can run the container with the command bellow:

podman compose up -d

docker desktop podman

Variables

The project uses environment variables to configure the application. You can copy a .env.template file in the root of the project and rename it to .env. After that you can set the variables in the file.

Execution

After that you can run the project in a dev mode with the command bellow:

yarn start:dev

Test

To run the tests you can run the command bellow:

yarn run test

Note

if you want to run in another mode you can see the package.json file in the root of the project.

Postman

You can import the postman collection to test the API. You can access the collection in the link bellow:

Postman Collection