SOL - Sistema online de licitação API

💻 Requisitos

Descriçao

Sol API.

Instalação

Acesse o diretório raiz da API e execute o comando.

$ npm install

Rodar seed

Execute o comando:

$ npm run seed

Preparar o ambiente

1. Acesse o diretório raiz da API e execute o comando abaixo:

$ docker-compose up -d

Para utilizar o Docker, é necessário abrir o arquivo docker-compose.yml e configurar a senha, nome da base, etc.

2. Crie um arquivo .env na pasta raiz da API com o seguinte formato:

PORT=4002
NOSQL_CONNECTION_STRING=mongodb://localhost:20000/lacchain
JWT_KEY=secret_KEY
JWT_REFRESH_TOKEN_KEY=****************==
JWT_ACCESS_TOKEN_EXPIRATION=8h
JWT_REFRESH_TOKEN_EXPIRATION=7d
ENCRYPT_KEY=********-****-****-****-************
[email protected]
SENDGRID_API_KEY=	**.****-****-*******.********-****

AWS_REGION=us-east-1
AWS_ACCESS_KEY_ID=******************
AWS_SECRET_ACCESS_KEY=**********/********/****

S3_BUCKET=dev-sol-app-api

S3_BUCKET_DOCUMENTS=dev-sol-app-api

S3_BUCKET_ANNOUNCEMENT_PHOTO=dev-sol-app-api

Descrição	Parâmetro
PORT	Porta em que a API será iniciada
NOSQL_CONNECTION_STRING	String de conexão com a base de dados, aqui deve ser adicionado o caminho publicado pelo docker compose.
JWT_KEY	Chave utilizada para a criptografia JWT
JWT_REFRESH_TOKEN_KEY	Chave utilizada para verificar a autenticidade dos Tokens de atualização JWT
JWT_ACCESS_TOKEN_EXPIRATION	Tempo de expiração do Token JWT
JWT_REFRESH_TOKEN_EXPIRATION	Tempo de expiração do Token de atualização JWT
ENCRYPT_KEY	Chave utilizada para a criptografia do Payload. Deve ser gerada pelo usuário e o mesmo deve estar de acordo com o frontend.
SENDGRID_EMAIL_SENDER	Email de origem para os serviços SendGrid
SENDGRID_API_KEY	Chave utilizada para autenticar e autorizar o acesso aos recursos do serviço SendGrid
AWS_REGION	Região do servidor AWS (Nulo caso não utilize AWS)
AWS_ACCESS_KEY_ID	Chave de acesso da AWS
AWS_SECRET_ACCESS_KEY	Autenticador de acesso para serviços AWS
S3_BUCKET	Bucket de armazenamento da AWS (Opcional, podendo utilizar outro bucket)
S3_BUCKET_DOCUMENTS	Bucket de armazenamento da AWS (Opcional, podendo utilizar outro bucket)
S3_BUCKET_ANNOUNCEMENT_PHOTO	Bucket de armazenamento da AWS (Opcional, podendo utilizar outro bucket)

Executando a API

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Documentação

Após executar a api acesse http://localhost:4002/docs

O Link pode mudar de acordo com a porta utilizada.

Testes

# end to end tests
$ npm run test:e2e

# end to end test watch
$ npm run test:e2e:watch

# test coverage
$ npm run test:e2e:cov

Suporte

[email protected]