💭 Descrição

Um projeto para o hackaton 4 da Onebitcode, com o objetivo de criar um gerenciamento de produtos de uma papelaria

Funcionalidades:

• Criar, atualizar, deletar e buscar produtos;
• Autenticação

💡 Informações do projeto

💻 Ambiente:

👨‍💻 Principais tecnologias:

• Node.js
  • Runtime
• Typescript
  • Superset, linguagem baseado no Javascript.
• Fastify
  • Framework web
• Prisma
  • ORM
• Zod
  • Validador de schema
• Json Web Tokens
  • Padrão para representação de reivindações/informações de forma segura
• Bcrypt
  • Biblioteca para fazer hash de senhas

🛠️ Modificando o projeto

Siga as seguintes instruções para instalar e poder modificar o projeto em sua máquina:

📋 Pré-requisitos:

Para baixar, executar e modificar o projeto, você precisa ter instalado em sua máquina:

• Node
• Um gerenciador de pacotes, como o PNPM, Npm ou Yarn
• Git
• Editor de código ou IDE, como o VSCode
• (Opcional) Docker

🔧 Instalação e execução

1. Clone o repositório

git clone https://github.com/Levieber/papelito-api.git

2. Acesse a pasta do projeto

cd papelito-api

3. Instale as depedências

// Com o Npm
npm i // Ou npm install

// Com o pnpm
pnpm i // Ou pnpm install
 
// Com o Yarn:
yarn // Ou yarn install

6. (Opcional - Caso tenha Docker) Executar docker compose up -d
7. Preencha as variáveis de ambiente necessárias
8. Inicie o servidor de desenvolvimento do projeto

// Com o Npm:
npm run dev

// Com o pnpm:
pnpm dev // Ou pnpm run dev  

// Com o Yarn:
yarn dev

Obs: o servidor iniciará na porta 3333 - acesse por: http://localhost:3333/

Agora, é sua hora de codar 🎮