API do To.do app

📃 Sobre

A API do To.do app que possui todas as operações necessárias para o seu funcionamento

🚀 Tecnologias

Este projeto foi desenvolvido com as seguintes tecnologias:

• NodeJS
• Fastify
• Postgres
• dot-env

👷 Instalação

Clone o repositório com o seguinte comando no seu terminal (Você precisa ter o Node.js e o Git instalados no seu computador)

git clone https://github.com/johnncaastro/to-do-api.git

Instale as dependências para o funcionamento do projeto

npm install

Entre na plataforma da neon.tech, crie a sua conta e faça o login

No menu lateral, entre em projetos e crie o seu no botão New Project (preencha apenas o nome e clique em Create project)

A criação das tabelas do banco de dados pode ser criada na opção Tables no menu lateral dentro do projeto criado. Outra opção seria criar um arquivo .js com o código abaixo:

import { sql } from './db.js'

sql`
  CREATE TABLE users (
    email SERIAL PRIMARY KEY,
    display_name TEXT NOT NULL
  );
`.then(() => {
  console.log('Tabela users criada!')
})

sql`
  CREATE TABLE tasks (
      id TEXT PRIMARY KEY,
      title TEXT NOT NULL,
      created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
      is_complete BOOLEAN DEFAULT FALSE,
      task_group TEXT,
      FOREIGN KEY (user_email) REFERENCES users (email) ON DELETE CASCADE
  );
`.then(() => {
  console.log('Tabela tasks criada!')
})

Na sua conta do neon, entre no menu Dashboard, clique em Copy snippet dentro do campo Connection string, volte ao projeto Node, crie um arquivo com o nome .env na raiz do projeto e dentro dele insira o código abaixo substituindo o string-de-conexao pelo snippet:

DATABASE_URL="string-de-conexao"

🏃 Começando

Insira o comando abaixo para iniciar a aplicação:

npm run start

Após esses passos, a aplicação já está pronta para o uso. Existem programas que ajudam a realizar requisições para a API, como por exemplo o Insomnia. Além disso, se o seu editor de código for o VSCode existe uma extensão chamada REST Client, que também ajuda nisso.

📝 Licença

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

---

Feito com ♥ por John Castro 👋 Entre em contato!