Skip to content

Latest commit

 

History

History
215 lines (167 loc) · 6.93 KB

README.md

File metadata and controls

215 lines (167 loc) · 6.93 KB
Raw

Logo

FindBots Botlist

A botlist made in nodejs + mongoose open source.
Explore the docs »

View Demo · Report Bug · Request Feature

WORK IN PROGRESS

Contributors Forks Stargazers Issues MIT License

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact

About The Project

FindBots Homepage Preview

(More screenshots)

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 ⭐.

(back to top)

Getting Started

Prerequisites

  • npm 
    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

    git clone https://github.com/klaus-2/FindBots-Botlist.git

  2. Install NPM packages

    npm install

  3. Enter your data in config.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.

(back to top)

Roadmap

  • Website base structure
  • 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 for a full list of proposed features (and known issues).

(back to top)

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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Discord - Klaus#1565

DawnForge Server - Invite link

(back to top)