https://github.com/klaus-2/findbots-botlist
(WIP) A botlist made in nodejs + mongoose open source.
https://github.com/klaus-2/findbots-botlist
Last synced: 4 months ago
JSON representation
(WIP) A botlist made in nodejs + mongoose open source.
- Host: GitHub
- URL: https://github.com/klaus-2/findbots-botlist
- Owner: klaus-2
- License: mit
- Created: 2022-05-31T19:01:04.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-20T15:02:05.000Z (about 2 years ago)
- Last Synced: 2024-11-12T16:39:15.630Z (6 months ago)
- Language: EJS
- Size: 4.97 MB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
FindBots Botlist
A botlist made in nodejs + mongoose open source.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
---
WORK IN PROGRESS
---
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
Table of Contents
## About The Project
[![FindBots Homepage Preview][product-screenshot]](#)
I'm creating this botlist for learning purposes. It won't be a perfect project, far from it, but I'll try to make it the best I can.
I'll be working slowly, gradually I'll finish this botlist. If you're interested in helping me, just look for me at Discord!
My goals are to create a website, a dashboard, an integrated bot and an api.
Feel free to suggest suggestions during the creation process, and if you like this project, please leave a ⭐.
## Getting Started
### Prerequisites
- npm
```sh
npm install npm@latest -g
```
### Installation
_Step 4 is optional. Note that you must configure all data inside config.js for the site to run smoothly._
1. Clone the repo
```sh
git clone https://github.com/klaus-2/FindBots-Botlist.git
```
2. Install NPM packages
```sh
npm install
```
3. Enter your data in `config.js`
```js
botconfig: {
ownerID: 'id', // your discord userID
token: 'token', // your bot token | https://discord.com/developers/applications/yourBotID/bot
MongoDBURL: 'mongodburl', // https://www.mongodb.com/
},
site: {
client_id: "id", // bot clientID
secret: "secret", // bot client secret for auth
description: "desc...", // Description for site metatags
domain: "https://domain", // domain with protocol without / (E.g. http://127.0.0.1)
port: "port", // port (E.g 80)
analitics: false, // For Dashboard analitcs -[Page views, geo]-
fakeData: false,
tags: ['Music', 'Fun', 'Economy', 'Anime', 'Game', 'Meme', 'Social', 'Leveling', 'Roleplay', 'Logging', 'Dashboard', 'Stream', 'Utility', 'Moderation', 'Crypto', 'Media', 'Customizable', 'Nsfw', 'Infantil', 'Game', 'Multipurpose', 'Multiple-Language', 'Slash Commands'],
},
server: {
id: "ID"
},
// API SETTINGS (For future)
API: {
port: 'port',
token: 'token',
},
```
4. In config.js, `fakeData: false` change to true if you want to use dummy data for a better view of current site features.
5. Open `start.bat` to start the website and bot.
## Roadmap
- [x] Website base structure
- [x] Basic Bot
- [ ] Advanced bot
- [ ] Logs
- [ ] Commands (Like !queue, !vote )
- [ ] User Dashboard
- [ ] Profile (Router /@me & /@users/userID)
- [ ] Bot/Server Settings
- [ ] API Settings
- [ ] Admin Dashboard
- [ ] API
- [ ] Multi-language Support
- [ ] Portuguese
- [ ] English
- [ ] Others...
- [ ] Add Servers
- [ ] Badges for Users & Bots
- [ ] Areas for bot banners boosted
- [ ] Search System
- [ ] Queue System base
- [ ] Admin page (View, approve and denied)
- [ ] User page (View position)
- [ ] Finish the Comment System
- [ ] Add Star Rating
See the [open issues](https://github.com/klaus-2/FindBots-Botlist/issues) for a full list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
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 MIT License. See `LICENSE.txt` for more information.
## Contact
Discord - [Klaus#1565](https://discordapp.com/users/622812963572809771/)
DawnForge Server - [Invite link](https://discord.gg/D8dWtRWfYt)
[contributors-shield]: https://img.shields.io/github/contributors/klaus-2/FindBots-Botlist.svg?style=for-the-badge
[contributors-url]: https://github.com/klaus-2/FindBots-Botlist/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/klaus-2/FindBots-Botlist.svg?style=for-the-badge
[forks-url]: https://github.com/klaus-2/FindBots-Botlist/network/members
[stars-shield]: https://img.shields.io/github/stars/klaus-2/FindBots-Botlist.svg?style=for-the-badge
[stars-url]: https://github.com/klaus-2/FindBots-Botlist/stargazers
[issues-shield]: https://img.shields.io/github/issues/klaus-2/FindBots-Botlist.svg?style=for-the-badge
[issues-url]: https://github.com/klaus-2/FindBots-Botlist/issues
[license-shield]: https://img.shields.io/github/license/klaus-2/FindBots-Botlist.svg?style=for-the-badge
[license-url]: https://github.com/klaus-2/FindBots-Botlist/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/othneildrew
[product-screenshot]: site/static/assets/github-images/home.png