A progressive Node.js framework for building efficient and scalable server-side applications.

✨ Tecnologias

Esse projeto foi desenvolvido com as seguintes tecnologias:

• TypeScript
• NestJS
• TypeORM
• Jest
• SQL Editor Beekeeper Studio
• Insomnia (Documentação)
• Axios

💻 Projeto

O Doctors API é uma aplicação que consiste em fazer todas operações (Insert, Update, Select, Delete) de Doutores. Nele realizamos o cadastro de Doutores e suas especialidades, podendo também gerenciar suas informações, como editar ou excluí-las.

Esse projeto foi desenvolvido para um teste da empresa GCB Investimentos. Onde foi utilizado o framework NestJS para desenvolver a aplicação, junto ao TypeORM.

Clonar e Instalar

Para rodar este projeto você precisa ter instalado o NodeJS

$ git clone https://github.com/jaovito/doctors.git doctors

$ cd doctors

$ npm install # ou yarn install

Documentação

A documentação foi feita com o Insomnia e todos os dados estão nas pastas .insomnia e public.

Rodando a aplicação

Primeiro passo você deve colar os dados do arquivo ormconfig.example.json para um arquivo ormconfig.json e substituí-los pelos dados que utiliza no seu banco de dados, o meu ficou assim:

{
  "type": "mysql",
  "host": "localhost",
  "port": 3306,
  "username": "root",
  "password": "docker",
  "database": "doctors",
  "entities": ["dist/**/*.entity.js"],
  "migrations": ["./dist/database/migrations/*.js"],
  "cli": {
    "migrationsDir": "./dist/database/migrations"
  }
}

OBS: LEMBRE DE ALTERAR OS DADOS DO ormconfig.json PARA OS DADOS DO SEU BANCO DE DADOS.

Após o ormconfig.json estar configurado, você deve rodas as migrations com o comando:

$ npm run typeorm migration:run # ou yarn typeorm migration:run

Após ter executado todas as migrations deve executar algum dos comandos abaixo:

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

OBS: A APLICAÇÃO DEVERÁ RODAR NA PORTA 3333 (http://localhost:3333).

Testes

Antes de rodar os testes e2e deve alterar o banco de dados teste, para isso deve abrir o arquivo databaseTest.ts na pasta test e alterar as variáveis para os dados correspondentes do seu banco de dados de teste, no meu caso subi esse arquivo normalmente para você conseguir testar sem problemas, mas o ideal seria coloca-lo em seu .gitignore para não comprometer seus dados, mas fique tranquilo que no meu caso não influencia em nada.

O meu ficou assim:

export default {
  type: 'mysql',
  host: 'localhost',
  port: 3306,
  username: 'root',
  password: 'docker',
  database: 'doctors_test',
};

Com isso você pode rodar os testes tranquilamentes

# unit tests
$ npm run test # ou yarn test

# e2e tests
$ npm run test:e2e # ou yarn test:e2e

# test coverage
$ npm run test:cov # ou yarn test:cov

Buildar a aplicação

Para executar o Build é bem simples

Mantenha contato

• Author - João Vitório
• Linkedin - João Vitório

License

Nest is MIT licensed.