https://github.com/the-sourcecode/sourcebot.net
https://github.com/the-sourcecode/sourcebot.net
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/the-sourcecode/sourcebot.net
- Owner: The-SourceCode
- License: apache-2.0
- Created: 2019-05-23T16:10:50.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-05-17T15:10:03.000Z (about 6 years ago)
- Last Synced: 2025-03-24T13:11:17.849Z (about 1 year ago)
- Language: JavaScript
- Size: 1.66 MB
- Stars: 9
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/The-SourceCode/sourcebot.net/issues/new)* section.
## Installation & Setup
You need to have the following:
* [Node/NPM](https://nodejs.org/en/ 'download nodejs')
* [Mongo](https://www.mongodb.com/cloud/atlas 'Get a free db') database
* [Discord](https://discordapp.com/developers/applications/ 'Create a Bot app') bot token
* [Jade/Pug](https://pugjs.org/api/getting-started.html) knowledge
* [Express](https://expressjs.com/) knowledge
* [Mongoose](https://mongoosejs.com/) 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/`.
* For making any *fixes*, it's more of the same thing, the branch should be named `fix/`
* `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](https://pm2.io/runtime/ 'Install PM2'))
* Push the new branch to your fork `git push origin feature/foobar`
* Make a pull request [here](https://github.com/The-SourceCode/SourceBot.net/compare 'Make pull request').
Check our [Trello](https://trello.com/b/Ix5E9Fcj/sourcebotwebsite) board to keep you updated of the changes being made.\
Thank you for your contributions.