Skip to content

Latest commit

 

History

History
162 lines (118 loc) · 4.66 KB

README.md

File metadata and controls

162 lines (118 loc) · 4.66 KB
Raw

CrazyStack Typescript Node.js - Sistema de Agendamentos Online 🚀

Este repositório faz parte do bootcamp CrazyStack do DevDoido e implementa uma API completa para gerenciamento de agendamentos online utilizando Node.js. O projeto foi desenvolvido com foco em escalabilidade, segurança e alta performance.

Sumário 📚

Tecnologias Utilizadas 🛠️

Este projeto utiliza as seguintes tecnologias:

  • Node.js 🟢 para a criação do servidor.
  • Fastify ⚡ como framework de servidor web, com suporte a WebSockets.
  • MongoDB 🐱‍💻 para banco de dados, usando MongoDB Memory Server para testes.
  • KafkaJS 🐻 para integração com o Apache Kafka.
  • Redis 🧊 (via IORedis) para gerenciamento de cache.
  • JWT (JsonWebToken) 🔐 para autenticação e autorização.
  • Axios 📦 para requisições HTTP.
  • Stripe 💳, Woovi (PIX) 💸 e Pagar.me 💵 para integração com pagamentos.

Requisitos ✅

  • Node.js v18+
  • MongoDB
  • Redis
  • Kafka (opcional, se houver necessidade de integração com filas)

Instalação 🛠️

  1. Clone o repositório:

    git clone https://github.com/gumiranda/CrazyStackNodeJs.git

  2. Acesse a pasta do projeto:

    cd CrazyStackNodeJs

  3. Instale as dependências:

    yarn

  4. Compile o projeto (caso esteja usando TypeScript):

  yarn build
  1. Rode o projeto:
  yarn start

Configuração ⚙️

Crie um arquivo .env na raiz do projeto e defina as variáveis de ambiente necessárias. Aqui está um exemplo de configuração:

# Configurações do MongoDB
MONGO_URL=mongodb+srv://seuusuario:suasenha@clusterseilaoqdomongo.mongodb.net/nomedobanco?retryWrites=true&w=majority
MONGO_URL_PROD=mongodb+srv://seuusuario:suasenha@clusterseilaoqdomongo.mongodb.net/nomedobanco?retryWrites=true&w=majority

# Ambiente de produção
NODE_ENV=production

# Segurança e autenticação
JWT_SECRET=hdfshfhf8ds8fds8fds8f8

# Configurações do Redis
REDIS_PORT=40043
REDIS_URL=us1-active-EXAMPLE-40043.upstash.io
REDIS_PASSWORD=YOUR_PASSWORD

# API do Google Maps
GOOGLE_MAPS_API_KEY=YOURGOOGLEMAPSKEY

# Kafka
KAFKAJS_NO_PARTITIONER_WARNING=1
KAFKA_USERNAME=
KAFKA_PASSWORD=
KAFKA_HOST=
KAFKA_CLIENT_ID=

# Gateways de pagamento
WOOVI_KEY=YOUR_WOOVI_KEY
PAGARME_SECRET_KEY=YOUR_PAGARME_SECRET_KEY
PAGARME_PUBLIC_KEY=YOUR_PAGARME_PUBLIC_KEY
PUBLIC_STRIPE_KEY=YOUR_STRIPE_PUBLIC_KEY
SECRECT_STRIPE_KEY=YOUR_STRIPE_SECRET_KEY

# Banco de dados Postgres (Neon)
PGHOST='ep-black-water-a5s6ziyz.us-east-2.aws.neon.tech'
PGDATABASE='neondb'
PGUSER='neondb_owner'
PGPASSWORD='nvi9XBpaRVQ0'
ENDPOINT_ID='ep-black-water-a5s6ziyz'
PGPORT=5432
FUSORARIOBR="production"
DATABASE="postgres"

# Provedores de armazenamento
UPLOAD_PROVIDER=cloudflare_r2
CLOUDFLARE_R2_ACCOUNT_ID=your_account_id
CLOUDFLARE_R2_ACCESS_KEY_ID=your_access_key_id
CLOUDFLARE_R2_SECRET_ACCESS_KEY=your_secret_access_key
CLOUDFLARE_R2_BUCKET_NAME=your_bucket_name

S3_ACCESS_KEY_ID=your_s3_access_key_id
S3_SECRET_ACCESS_KEY=your_s3_secret_access_key
S3_BUCKET_NAME=your_s3_bucket_name
S3_REGION=your_s3_region

GCS_PROJECT_ID=your_gcs_project_id
GCS_BUCKET_NAME=your_gcs_bucket_name
GCS_KEY_FILENAME=path_to_your_gcs_keyfile

AZURE_STORAGE_CONNECTION_STRING=your_azure_connection_string
AZURE_CONTAINER_NAME=your_azure_container_name

Comandos Disponíveis 🖥️

  • yarn start: Inicia a API em produção.
  • yarn build: Remove a pasta dist e compila o TypeScript.
  • yarn test: Executa os testes com o Jest.
  • yarn format: Formata o código utilizando Prettier.
  • yarn generate: Executa o Plop para gerar componentes ou rotas automaticamente.

Scripts de Teste 🧪

  • yarn test:db: Testa a integração com o banco de dados.
  • yarn test:all: Executa todos os testes.
  • yarn test:spec: Testa arquivos específicos.
  • yarn test:t: Testes personalizados.
  • yarn test:v: Testes com output detalhado.

Contribuição 🤝

Contribuições são bem-vindas! Se você deseja melhorar este projeto, sinta-se à vontade para abrir uma issue ou enviar um pull request.

Licença 📜

Este projeto está licenciado sob a Licença MIT. Consulte o arquivo LICENSE para mais detalhes.


Adicionei emojis para tornar o README mais visualmente atraente e destaquei as bibliotecas e tecnologias utilizadas. Sinta-se à vontade para modificar conforme necessário!