Saturno Notes API

Saturno Notes API é a API desenvolvida para o projeto Saturno Notes. Esta API lida com a autenticação de usuários, gerenciamento de notas e armazenamento de dados usando um banco de dados SQLite. A aplicação foi construída com o objetivo de fornecer uma interface robusta e escalável para o front-end do Saturno Notes.

Funcionalidades

• Autenticação de Usuário: Realiza o login e registro de usuários utilizando JWT (JSON Web Tokens).
• Gerenciamento de Notas: Permite aos usuários criar, editar, excluir e listar suas notas.
• Organização de Notas: As notas podem ser associadas a categorias e tags.
• Upload de Arquivos: A API suporta o upload de arquivos através do multer para armazenar imagens de perfil, por exemplo.

Tecnologias Utilizadas

• Node.js: Ambiente de execução para JavaScript no servidor.
• Express: Framework web para construir a API.
• Knex: Query builder para facilitar o acesso ao banco de dados SQLite.
• SQLite3: Banco de dados leve e embutido.
• JWT (JSON Web Tokens): Utilizado para autenticação de usuários.
• Bcryptjs: Para hash de senhas e segurança da aplicação.
• Multer: Middleware para upload de arquivos.
• PM2: Gerenciamento de processos para produção.

Instalação

Para rodar o projeto localmente, siga os seguintes passos:

1. Clone o repositório:

   git clone https://github.com/FrancisBernard34/saturno-notes-api.git

2. Navegue até o diretório do projeto:

   cd saturno-notes-api

3. Instale as dependências:

   npm install

4. Crie um arquivo .env a partir do arquivo de exemplo .env.example:

   cp .env.example .env

5. Abra o arquivo .env e preencha as variáveis com as informações apropriadas:

   AUTH_SECRET=your_secret_key
   PORT=3001

6. Crie o banco de dados e realize as migrações:

   npm run migrate

7. Execute a aplicação em modo de desenvolvimento:

   npm run dev

8. A API estará disponível em http://localhost:3001.

Scripts

• npm run dev: Executa a API em modo de desenvolvimento com nodemon.
• npm run start: Executa a API em produção com pm2.
• npm run migrate: Executa as migrações para o banco de dados utilizando knex.
• npm run test: Executa os testes utilizando jest.

Contribuição

Se você deseja contribuir para o projeto, sinta-se à vontade para abrir uma issue ou enviar um pull request. Seu feedback é muito bem-vindo!

---

Desenvolvido por Francis Bernard