Skip to content

Commit 7587aff

Browse files
Release v1.0.0-ALPHA.7 (#6)
2 parents 668b9f9 + 9f2f261 commit 7587aff

25 files changed

+1150
-3674
lines changed

.github/translation/readme-enUS.md

Lines changed: 0 additions & 129 deletions
This file was deleted.

.github/translation/readme-ptBR.md

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
<!-- [<img width="100%" src="https://raw.githubusercontent.com/ArunaBot/ArunaBase/main/.github/assets/mainBanner.png) -->
2+
<p align="center">
3+
<a href="https://www.npmjs.com/package/arunabase"><img src="https://img.shields.io/npm/v/arunabase.svg?style=for-the-badge&maxAge=3600"></a>
4+
<a href="https://discord.gg/NqbBgEf" target="_blank"><img src="https://img.shields.io/discord/660610178009530380?color=5865F2&label=&logo=Discord&logoColor=white&style=for-the-badge"></a>
5+
<a href=""><img src="https://img.shields.io/github/license/arunabot/arunabase?style=for-the-badge&color=0394fc&label=Licen%C3%A7a"></a>
6+
</p>
7+
8+
#
9+
10+
<p align="center"><a href='https://github.com/arunabot/arunabase#readme'>📘 English Readme</a> | <span>📕 Readme em português</span></p>
11+
12+
#
13+
14+
<h2 align="center">📖 Sobre</h2>
15+
&nbsp;&nbsp;&nbsp;&nbsp;A ArunaBase é uma base de código de API para bots do Discord, Twitch, e outras plataformas, feita em TypeScript, com o objetivo de facilitar a criação de bots, com uma estrutura simples e organizada, além de ser totalmente gratuita e de código aberto.
16+
17+
<br>
18+
19+
&nbsp;&nbsp;&nbsp;&nbsp;Com a ArunaBase criar um bot capaz de executar comandos, interagir com o usuário, em plataformas como o Discord e a Twitch, além de ter uma configuração simples e intuitiva, é muito fácil e rápido.
20+
21+
<br>
22+
23+
<h2 align="center">💻 Instalação</h2>
24+
&nbsp;&nbsp;&nbsp;&nbsp;Para instalar a ArunaBase no seu projeto, você precisa ter o NodeJS instalado, e então executar o seguinte comando no seu terminal:
25+
26+
<br>
27+
28+
### NPM:
29+
```
30+
npm install arunabase
31+
```
32+
33+
<br>
34+
35+
### Yarn:
36+
```
37+
yarn add arunabase
38+
```
39+
40+
<br>
41+
42+
<h2 align="center">⌨ Exemplo de uso</h2>
43+
&nbsp;&nbsp;&nbsp;&nbsp;Para usar a ArunaBase em seu projeto, você precisa importar uma das classes que ela exporta, e então criar uma instância da classe que você importou, passando como parâmetro um objeto com as configurações do seu bot.
44+
45+
<br>
46+
47+
<h2 align="center">🗨 Exemplo de uso com o Discord</h2>
48+
49+
<br>
50+
51+
```js
52+
const { Discord } = require('arunabase');
53+
// ou
54+
import { Discord } from 'arunabase';
55+
56+
const client = new Discord.DiscordClient({
57+
botID: '<Id do bot>',
58+
intents: [
59+
Discord.Intents.Flags.MessageContent, // Opcional
60+
// ...
61+
],
62+
});
63+
64+
// use client.getCommandManager().generateCommand('Nome do comando', parâmetros do comando); para criar comandos.
65+
// use client.getCommandManager().registerCommand(comando); para registrar o comando.
66+
67+
client.on('ready', () => {
68+
console.log('Bot pronto!');
69+
});
70+
71+
client.login('<Token do bot>');
72+
```
73+
74+
<br>
75+
76+
<h2 align="center">📄 Licença</h2>
77+
78+
<br>
79+
80+
&nbsp;&nbsp;&nbsp;&nbsp;A ArunaBase é distribuída sob a licença GNU. Veja [LICENSE](/LICENSE) para mais informações.
81+
82+
<br>
83+
84+
<h2 align="center">🤝 Contribuições</h2>
85+
86+
<br>
87+
88+
&nbsp;&nbsp;&nbsp;&nbsp;Contribuições são o que fazem a comunidade de código aberto um lugar incrível para aprender, inspirar e criar. Qualquer contribuição que você fizer será **muito apreciada**.
89+
90+
1. Faça um Fork do projeto
91+
2. Crie sua Feature Branch (`git checkout -b feature/AmazingFeature`)
92+
3. Commit suas mudanças (`git commit -m 'Add some AmazingFeature'`)
93+
4. Push para a Branch (`git push origin feature/AmazingFeature`)
94+
5. Abra um Pull Request
95+
96+
<br>
97+
98+
<h2 align="center">😉 Autores</h2>
99+
100+
<br>
101+
102+
<table align="center">
103+
<tr>
104+
<td align="center">
105+
<a href="https://github.com/LoboMetalurgico">
106+
<img src="https://avatars.githubusercontent.com/u/43734867?v=4" width="100px;" alt=""/>
107+
<br />
108+
<sub>
109+
<b>LoboMetalurgico</b>
110+
</sub>
111+
</a>
112+
</td>
113+
<td align="center">
114+
<a href="https://github.com/emanuelfranklyn">
115+
<img src="https://avatars.githubusercontent.com/u/44732812?v=4" width="100px;" alt=""/>
116+
<br />
117+
<sub>
118+
<b>SpaceFox</b>
119+
</sub>
120+
</a>
121+
</td>
122+
</tr>
123+
</table>
124+
125+
#
126+
127+
<p align="center">Feito com 💚 pela equipe da Aruna™.</p>
128+
129+
<p align="center">Todos os direitos reservados.</p>

.github/workflows/gitpublish.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,13 @@ jobs:
3131
runs-on: ubuntu-latest
3232
steps:
3333
- name: Checkout repository
34-
uses: actions/checkout@v3
34+
uses: actions/checkout@v4
3535
- name: "Refresh tags"
3636
id: tag
3737
run: git fetch --tags --force
3838
- name: Get Current version
3939
id: current_version
4040
run: echo ::set-output name=version::$(node -p "require('./package.json').version")
41-
- name: Echo Debug
42-
run: |
43-
echo "${{ steps.current_version.outputs.version }}"
4441
- name: Create GitHub release
4542
uses: Roang-zero1/github-create-release-action@master
4643
with:
Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,27 @@
11
name: Publish API to NPM
22

33
on:
4-
push:
5-
branches:
6-
- release
4+
release:
5+
types: [published]
76

87
jobs:
98
publish:
109
runs-on: ubuntu-latest
10+
permissions:
11+
contents: read
12+
id-token: write
1113
steps:
1214
- name: Checkout repository
13-
uses: actions/checkout@v3
15+
uses: actions/checkout@v4
1416

1517
# Setup .npmrc file to publish to npm
1618
- name: Setup .npmrc (NPM)
17-
uses: actions/setup-node@v3
19+
uses: actions/setup-node@v4
1820
with:
19-
node-version: '16.x'
21+
node-version: '22.x'
2022
registry-url: 'https://registry.npmjs.org'
2123
scope: '@arunabot'
2224

23-
- name: Enforce npm 8
24-
run: npm install -g [email protected]
25-
2625
- name: Get Current version
2726
id: current_version
2827
run: echo ::set-output name=version::$(node -p "require('./package.json').version")
@@ -39,14 +38,7 @@ jobs:
3938
- name: Install dependencies
4039
run: npm ci
4140

42-
- name: Build
43-
run: npm run build
44-
45-
- name: Prepare to publish
46-
run: npm run pdeploy
47-
4841
- name: Publish to npm
49-
working-directory: ./build
50-
run: npm publish
42+
run: npm publish --provenance --access public
5143
env:
5244
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.nvmrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
lts/hydrogen
1+
lts/jod

0 commit comments

Comments
 (0)