Este app é uma API de lista de tarefas estilo TaskBoard, cuidadosamente projetada para oferecer uma experiência fluida e eficaz na gestão de tarefas. Proporcionando uma interface intuitiva e eficiente, esta aplicação se destina a simplificar a organização de tarefas, tornando o processo de planejamento e acompanhamento mais acessível e conveniente.
Além de sua eficácia inerente, nossa API de lista de tarefas é acompanhada de uma documentação detalhada e interativa disponibilizada por meio do Swagger. Essa integração com o Swagger não apenas simplifica o processo de entendimento da API, mas também fornece aos desenvolvedores uma maneira eficaz de explorar, testar e personalizar os recursos da aplicação. A documentação Swagger oferece uma visão clara e abrangente de cada ponto final, parâmetros, métodos e exemplos práticos de uso, garantindo que os usuários possam tirar o máximo proveito da API de lista de tarefas.
Este foi o terceiro repositório de código apresentado no Curso Superior de TSI do IFMS como requisito para obtenção da nota parcial das atividades da unidade curricular Web Services.
| ← Repositório anterior | Próximo repositório → |
|---|
| Papel | Tecnologia |
|---|---|
| Linguagem de programação | TypeScript |
| Framework back-end | Express.js |
| Banco de dados | SQLite |
| Mapeamento Objeto-Relacional | TypeORM |
| API de documentação dinâmica | Swagger |
-
Clone o repositório de código em sua máquina;
-
Abra um shell de comando de sua preferência (prompt de comando, PowerShell, terminal etc.);
-
Instale as dependências do projeto através do seguinte comando:
$ npm installCaso esteja utilizando o gerenciador de pacotes Yarn, execute o seguinte comando como alternativa:
$ yarn- Execute o seguinte comando para executar o app:
Para npm:
$ npm run startPara Yarn:
$ yarn start- Acesse o endereço de URL http://localhost:3001/docs para conferir a documentação da API gerada pelo Swagger a partir dos arquivos YAML.