TexCycle API

API development for the app consumption

📋 Sobre o Projeto

TexCycle API é uma API REST desenvolvida em Node.js para gerenciar autenticação e serviços relacionados ao aplicativo TexCycle. A API utiliza PostgreSQL como banco de dados e implementa autenticação JWT.

🚀 Tecnologias

• Node.js com Express
• PostgreSQL - Banco de dados relacional
• Sequelize - ORM para Node.js
• JWT - Autenticação e autorização
• bcryptjs - Criptografia de senhas
• Docker - Containerização

📦 Dependências Principais

{
  "express": "~4.16.1",
  "sequelize": "^6.37.7",
  "pg": "^8.11.3",
  "jsonwebtoken": "^9.0.2",
  "bcryptjs": "^2.4.3",
  "cors": "^2.8.5",
  "dotenv": "^16.3.1"
}

⚙️ Instalação

1. Clone o repositório:

git clone https://github.com/TexCycle/textcycle-api.git
cd textcycle-api

2. Navegue até o diretório do serviço de autenticação:

cd auth_service

3. Instale as dependências:

npm install

4. Configure as variáveis de ambiente:

cp .env.example .env

Edite o arquivo .env com suas configurações de banco de dados e JWT.

🐳 Docker

Se você estiver usando Docker, utilize os comandos apropriados para construir e executar os containers.

🎯 Scripts Disponíveis

# Iniciar o servidor em produção
npm start

# Iniciar o servidor em modo de desenvolvimento (com nodemon)
npm run dev

# Verificar conexão com o banco de dados
npm run check-db

# Criar usuário administrador
npm run create-admin

🗄️ Banco de Dados

O projeto utiliza PostgreSQL com Sequelize ORM. Para configurar o banco de dados:

1. Certifique-se de que o PostgreSQL está instalado e rodando
2. Configure as credenciais no arquivo .env
3. Execute as migrations (se disponíveis)

🔐 Autenticação

A API implementa autenticação JWT (JSON Web Tokens) com bcrypt para hash de senhas, garantindo segurança nas operações.

📝 Estrutura do Projeto

textcycle-api/
├── auth_service/
│   ├── scripts/
│   │   ├── check-db.js
│   │   └── create-admin.js
│   ├── server.js
│   ├── package.json
│   └── ... 
└── README.md

🤝 Contribuindo

Contribuições são bem-vindas! Sinta-se à vontade para abrir issues e pull requests.

👥 Organização

Este projeto é mantido pela organização TexCycle.

📄 Licença

Este projeto não possui uma licença específica definida.

---

Desenvolvido com ❤️ pela equipe TexCycle