jacxk / sourcebot.net

SourceBot Website

An Open-Source project from TheSourceCode

---

Info 📍

Welcome to the official SourceBot's website where you can check user's rank, levels, exp, etc.

This project is open source, so you can help us improve the website and issues that you might encounter.

Make sure to check it out! https://sourcebot.net/

Contributing 📝

For Developers: If you see any errors and you know how to fix it or you want to add a new feature, check the installation and setup section bellow.
For Non-Developers: If you see an error make sure you let us know in the issues section.

Installation & Setup

You need to have the following:

• Node/NPM
• Mongo database
• Discord bot token
• Jade/Pug knowledge
• Express knowledge
• Mongoose knowledge

Then you must do the following:

• Fork and clone the repository
• Clone the config.example.js file and rename it to config.js and fill out the credentials.
• npm run install (To get all the dependencies.)
• Create a branch for your feature/fix.
  • To make any new features you must create a separate branch named feature/<feature-name>.
  • For making any fixes, it's more of the same thing, the branch should be named fix/<fix-name>
• npm start (And check if there are any errors)
  • If you want the website to restart/reload with the changes you made use npm run watch instead. (You must have PM2)
• Push the new branch to your fork git push origin feature/foobar
• Make a pull request here.

Check our Trello board to keep you updated of the changes being made.
Thank you for your contributions.