higorxi/corelab-api

Desafio Técnico To-do List Corelab-API 💻

Tecnologias • Iniciando o projeto • API Endpoints •

Este projeto tem como objetivo desenvolver uma aplicação web que permite aos usuários criar e gerenciar suas listas de tarefas (to-do lists). A aplicação será composta por uma página web responsiva construída em React para a interface do usuário e Node.js, Exprees.js e MongoDB, trabalhando no back-end. Esse repositório se trata do desenvolvimento da API, o front-end se encontra em (https://github.com/higorxi/corelab-frontend.git).

💻 Tecnologias

• Lista das tecnologias utilizada:
• Node.js
• Express.js
• MongoDB

🚀 Iniciando

Como iniciar o projeto localmente

Prerequisites

Para rodar o projeto é necessário ter instalado:

• NPM
• Git
• NodeJS
• Um editor de código, eu utilizo o:
• VS Code

Clonando

Para clonar o projeto do Github para sua máquina, digite:

git clone https://github.com/higorxi/corelab-api.git

Configurando .env variáveis de ambiente

Use o .env.example como referencia para criar seu arquivo .env para se conectar ao MongoDB, irei deixar o MONGOURI aqui, haja vista que é uma aplicação sem fins lucrativos e sem informações pessoais. Além disso, você pode configurar uma porta específica para rodar o servidor, para que não haja conflito com outra aplicação

MONGODB_URI=
PORT=

Iniciando

Como iniciar o projeto

cd corelab-api
npm install
npm start

📍 API Endpoints

Here you can list the main routes of your API, and what are their expected request bodies. Aqui estão as principais rotas da API que gera todas as operações do CRUD, além disso, podemos ver os corpos esperados das requisições ​

rota	descrição
GET /todos/	retorna todos os To-dos registrados detalhes da resposta
POST /todos/create	cria um novo card de To-do detalhes da criação

GET /todos/

RESPONSE

	{
		"_id": "65ac958ea2e7dfa3ac3217fe",
		"title": "123123",
		"description": "321321",
		"favorite": true,
    "color": "white"
		"__v": 0
	}

POST /todos/create

REQUEST

{
  "title": "testestes",
  "description": "Concluir capítu31231lo21212 5",
  "favorite": true,
  "color": "azul",
  "feito": true
}

RESPONSE

{
	"title": "testestes",
	"description": "Concluir capítu31231lo21212 5",
	"favorite": true,
	"color": "azul",
	"feito": true,
	"_id": "65aecc77a7076701a96db86c",
	"__v": 0
}