🛸 Chamado.app API

• 🛸 Chamado.app API
  • 📖 About
  • 📦 Prerequisites
  • 🛬 Cloning
  • 🏃 Running
  • 🧪 Testing

📖 About

Another service desk application.

This project is intended to be used as a basis for studies and in the construction of a Course Completion Work, of the Technology in Systems Analysis and Development course.

📦 Prerequisites

• Node.js ^18 or ^16 or ^14.19
• Yarn 1.21.1

🛬 Cloning

git clone [email protected]:chamado-app/chamado-app-api.git
# or
git clone https://github.com/chamado-app/chamado-app-api.git

cd chamado-app-api

🏃 Running

To run the project you need to have installed docker and docker-compose

In newer versions of docker it may be necessary to install docker buildx.

# Install dependencies for IDEs to work properly
yarn install

# Development
# Copy the .env.example file to .env and customize the environment variables.
# Define database user and password
cp .env.example .env

# Makes docker container up
make up

# Makes docker container down
make down

# Makes production docker image
make build

🧪 Testing

# unit tests
yarn run test

# e2e tests
yarn run test:e2e

# test coverage
yarn run test:ci