Skip to content

fsclaro/atl-api

Repository files navigation

Advanced TODO List - API Module

License


🧪 Tecnologias utilizadas

Para este projeto, foram utilizadas as seguintes tecnologias:

  • Node.js
  • Typescript
  • Express
  • JSONWebToken
  • Mongoose
  • bcryptjs

🚀 Como executar

Passo 1: Faça a clonagem do projeto com o comando abaixo:

$ git clone https://github.com/fsclaro/atl-api.git

Passo 2: Entre na pasta do projeto:

$ cd atl-api

Passo 3: instale as dependências do projeto conforme os passos descritos abaixo:

# Instalar as dependências
$ yarn

💻 Configuração

  1. Copiar o arquivo .env.example para .env
  2. Abrir o arquivo .env no seu editor de textos preferido
  3. Configurar os parâmetros conforme orientações.

💻 Subindo a API

Inicie o projeto conforme o passo descrito abaixo:

$ yarn start

A API estará disponível no seu browser pelo endereço https://localhost:3005.

📝 Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.