Notes API
JavaScript | Fastify | SQLite

Sobre   |    Tecnologias   |    Como Executar   |    Licença

🔖 Sobre o Projeto

O Notes é um sistema para você que deseja armazenar suas anotações em algum local. Com Notes você pode contar com a inserção, listagem, atualização e exclusão de suas anotações.

Essa API foi realizada durante o trabalho da M3 da matéria de banco de dados, lecionada pelo professor Mauricio Pasetto de Freitas.

🚀 Tecnologias Utilizadas

• Fastify
• Nodemon
• SQLite
• TypeORM

💥 Como Executar

• Pré-requisitos

  • É necessário possuir o Node.js instalado no computador.
  • É necessário possuir o Git instalado e configurado no computador.
  • Por fim, é preciso ter um gerenciador de pacotes seja o Yarn, NPM ou semelhantes.

1. Faça um clone do repositório:

  $ git clone https://github.com/DanielAraldiEDU/notes-api.git

2. Executando a Aplicação:

  # Instalando as dependências do projeto.
  $ npm install # ou yarn install
  # Inicie a API juntamente do banco de dados SQLite
  $ npm run dev # yarn dev

3. Consultar com o Insomnia: Vá a pasta chamada pipelines da raiz e baixe o arquivo .json que existe lá dentro. Com o seu Insomnia instalado, realize a importação desse arquivo para lá e fique a vontade para realizar as consultas!

4. (Opicional) - Quer ver nosso banco de dados? Caso você queria ver nosso banco de dados mais aprofundadamente, nós recomendamos utilizar o Beekeeper Studio para isso, basta fazer o download dele na sua máquina e após o download, no Beekeeper Studio selecione o banco de dados que você quer consultar, no nosso caso será o SQLite, e depois selecione o arquivo .sqlite no projeto que está em ./src/infra/db/typeorm/database.

5. (Opicional) - Aonde está o dump de criação do banco de dados? Vá na pasta dump que está na raiz do projeto, lá você encontrará os comandos SQL da aplicação.

📝 Licença

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

---

^{Projeto desenvolvido por Daniel Sansão Araldi e Arthur Moser.}