O sistema serve para gerenciar médicos e especialidades. Esses são as duas entidades presentes no sistema, e para cada uma delas é possível realizar as operações Criar, Atualizar, Listar, Deletar e Recuperar. O médico ainda conta com a operação de Filtrar.
Para rodar o sistema, é necessário ter instalado as seguintes bibliotecas:
Para baixar os arquivos do sistema do repositório remoto, basta utilizar o seguinte comando:
git clone git@github.com:ArthurEnrique15/doctors-specialties-crud.git && cd doctors-specialties-crudPara executar o sistema, basta utilizar o seguinte comando:
make app
O comando make app executa o serviço
appdo docker-compose e consequentemente os serviços dos quais ele depende, que são odatabasee asmigrations.Assim, a imagem do postgres é baixada, as migrations são executadas juntamente com o dockerfile do projeto e por fim a aplicação é iniciada na porta 3333.
Caso queira remover a aplicação execute
make destroy.
Após executar o sistema, a documentação de todas as rotas estará disponível no seguinte endereço: http://localhost:3333/api-docs/
Para executar os testes, basta utilizar o seguinte comando:
make test
Para a execução dos testes foram utilizadas as bibliotecas
jestesupertestO arquivo run-tests.png é um print da saída dos testes.
The system is used to manage doctors and specialties. These are the two entities present in the system, and for each of them it's possible to execute the following actions: Create, Update, List, Delete and Recover. It's also possible to execute a Filter action for the doctors.
To run the system, it's necessary to have the following libraries installed:
To download the system files from the remote repository, just run the following command:
git clone git@github.com:ArthurEnrique15/doctors-specialties-crud.git && cd doctors-specialties-crudTo run the system, just run the following command:
make app
The command make app executes the
appservice from docker-compose and the services that it depends on (databaseandmigrations).So the postgres image is downloaded, the migrations are executed along with the project Dockerfile, and finally the application is initialized in the port 3333.
If you want to remove the application, run the command
make destroy
After executing the system, the documentation of all routes will be available in the following address: http://localhost:3333/api-docs/
To run the tests, just run the following command:
make test
The libraries
jestandsupertestwhere used to run the tests.The file run-tests.png is a printscreen of the tests exit.