✨ AtosJS ✨

🎁 Um gerenciador de códigos simples, eficiente e poderoso para sistemas de recompensas! 🎯

🏷️ AtosJS

AtosJS é um gerenciador de "gifts" fácil de usar, perfeito para sistemas de recompensas, promoções e outros cenários onde a geração, visualização e resgate de códigos é necessária. 🚀

📦 Instalação

Adicione o AtosJS ao seu projeto com npm ou yarn:

npm install atosjs
# ou
yarn add atosjs

🛠️ Exemplos de Uso

1️⃣ Inicializando o AtosJS

import { GiftManager } from 'atosjs';

const giftManager = new GiftManager({ fileName: 'meuBancoDeGifts' });

2️⃣ Gerando um Gift

const giftId = await giftManager.generate({
    type: 'coins',
    amount: 500,
    expiration: '3d', // Expira em 3 dias
});
console.log(`Código gerado: ${giftId}`);

3️⃣ Visualizando um Gift

const giftDetails = await giftManager.view(giftId);
console.log(giftDetails);
// Saída: { valid: true, type: 'coins', amount: 500 }

4️⃣ Resgatando um Gift

const result = await giftManager.redeem(giftId);
if (result.success) {
    console.log('🎉 Gift resgatado com sucesso!');
} else {
    console.log('❌ O gift é inválido ou já foi resgatado.');
}

⚙️ Configurações

Opções

• fileName: Nome do arquivo para armazenamento dos dados (padrão: gifts).

Parâmetros de Geração

• type: Tipo do gift (ex: "coins", "item").
• amount: Valor associado ao gift.
• expiration: Tempo de expiração, no formato 10s, 5m, 1d, etc.

✅ Testes

Execute os testes com:

npm test

📚 Tecnologias Utilizadas

• Node.js
• TypeScript
• quick.db
• Jest

🤝 Contribuições

Contribuições são bem-vindas!

1. Faça um fork.
2. Crie um branch: git checkout -b minha-mudanca.
3. Faça um push: git push origin minha-mudanca.
4. Abra um Pull Request.

📄 Licença

Este projeto está sob a licença MIT.

👨‍💻 Autor

Criado com 💻 por yeyTaken.