Contact Verse

A Contact Verse é uma API de simulação de agenda desenvolvida em ExpressJS, utilizando TypeORM e Bcrypt para criptografia de senha.

Instalando as dependências

Para inciar este projeto, é necessário instalar as dependências. Portanto você deve acessar a pasta do front ou back e utilizar o comando abaixo para instalar as dependências:

Exemplo backend:
# acessando a pasta do backend
cd back

# instalando as dependências
# caso use npm
npm run i

# caso use yarn
yarn

Exemplo frontend:
# acessando a pasta do frontend
cd front

# instalando as dependências
# caso use npm
npm run i

# caso use yarn
yarn

Aplicar as migrações e gerar tabelas

Para gerar as tabelas com o TypeORM, é necessário utilizar o comando abaixo:

Na pasta do frontend:
# caso use npm
npm run typeorm migration:run -- -d ./src/data-source.ts

# caso use yarn
yarn typeorm migration:run -d ./src/data-source.ts

Rodando a aplicação localmente

Para rodar a aplicação localmente, também se faz necessário acessar a pasta de cada uma e utilizar o comando abaixo:

Exemplo backend:
# acessando a pasta do backend
cd back

## rodando a aplicação localmente
# caso use npm
npm run dev

# caso use yarn
yarn dev

Exemplo frontend:
# acessando a pasta do frontend
cd front

## rodando a aplicação localmente
# caso use npm
npm run dev

# caso use yarn
yarn dev

Rodando e visualizando a documentação do projeto

Para visualizar a documentação, acesse a pasta /documentation através do seu terminal e digite o comando

# acessando a pasta da documentação
cd documentation

# rode o comando abaixo e acesse o endpoint para visualizar a documentação
npx serve