Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bartolumiu/dexchan_rework
Rework of the Dex-chan Discord bot for the MangaDex ES server
https://github.com/bartolumiu/dexchan_rework
discordjs discordjs-v14 manga mangadex mangadex-api
Last synced: about 1 month ago
JSON representation
Rework of the Dex-chan Discord bot for the MangaDex ES server
- Host: GitHub
- URL: https://github.com/bartolumiu/dexchan_rework
- Owner: Bartolumiu
- License: gpl-3.0
- Created: 2024-08-07T02:00:26.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-05T02:48:22.000Z (about 1 month ago)
- Last Synced: 2024-10-12T02:41:32.631Z (about 1 month ago)
- Topics: discordjs, discordjs-v14, manga, mangadex, mangadex-api
- Language: JavaScript
- Homepage: https://mangadex.org/
- Size: 171 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Dex-chan (MangaDex ES)
Base code for the "Dex-chan" Discord bot
Explore the docs »
View Demo
.
Report Bug
.
Request Feature
   [](https://www.codefactor.io/repository/github/Bartolumiu/dexchan_rework/overview/main)
## Table Of Contents
* [Built With](#built-with)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
* [Authors](#authors)
* [Acknowledgements](#acknowledgements)
## Built With
* [Node.JS](https://nodejs.org)
* [Discord.JS](https://discord.js.org)
## Getting Started
To get a local copy of the bot up and running follow these steps.
### Prerequisites
* npm
```sh
npm install npm@latest -g
```
* pm2 (optional)
```sh
npm install pm2 -g
```
### Installation
1. Clone the repo
```sh
git clone https://github.com/Bartolumiu/dexchan_rework.git
```
2. Install NPM packages
```sh
npm install
```
2.1 Install PM2 (Optional / Needed for 4.3)
```sh
npm install -g pm2
```
3. Rename `.env.template` to `.env` and enter the following:
```env
token=ULTRA_SECRET_BOT_TOKEN
databaseToken=mongodbtoken
clientId=0123456789011121314
```
4. Start the bot
To start the bot, there are 3 different methods
4.1. Node:
```sh
node src/index.js
```
4.2. npm command
```sh
npm run test
```
4.3. pm2 (recommended)
```sh
pm2 start src/bot.js
```
## Roadmap
See the [open issues](https://github.com/Bartolumiu/dexchan_rework/issues) for a list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
* If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/Bartolumiu/dexchan_rework/issues/new) to discuss it, or directly create a pull request after you edit the *README.md* file with necessary changes.
* Please make sure you check your spelling and grammar.
* Create individual PR for each suggestion.
### Creating A Pull Request
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the Apache License 2.0. See [LICENSE](https://github.com/Bartolumiu/dexchan_rework/blob/main/LICENSE) for more information.
## Authors
* [Bartolumiu](https://github.com/Bartolumiu/)