|
|
|
|
@ -14,6 +14,8 @@ This project and everyone participating in it is governed by the Random Bunny Co
|
|
|
|
|
|
|
|
|
|
You can ask a question about the project in the `#development` channel in the [Discord Server](https://discord.gg/UyAhAVp).
|
|
|
|
|
|
|
|
|
|
You can also email me at [ethan@vylpes.com](mailto:ethan@vylpes.com) for general queries, or if you require support at [helpdesk@vylpes.com](mailto:helpdesk@vylpes.com)
|
|
|
|
|
|
|
|
|
|
## What you should know
|
|
|
|
|
|
|
|
|
|
### Javascript and Node
|
|
|
|
|
@ -76,9 +78,9 @@ Include details about your configuration and environment:
|
|
|
|
|
* **What's the name and version of the OS you're using?**
|
|
|
|
|
* **Are you running Random Bunny in a virtual machine?** If so, which VM software are you using and which operating systems and versions are used for the host and the guest?
|
|
|
|
|
* **What version of node do you have installed?** You can get this version by running the `node -v` command in your terminal.
|
|
|
|
|
* **What does your `config.json` file look like?**
|
|
|
|
|
* **What does your `.env` file look like?**
|
|
|
|
|
|
|
|
|
|
> **Note:** remember to **not** give out your bot tokens which are inside of the `config.json` file. If you're giving a copy of your configuration remember to delete the tokens from the string and leave the empty.
|
|
|
|
|
> **Note:** remember to **not** give out your bot tokens which are inside of the `.env` file. If you're giving a copy of your configuration remember to delete the tokens from the string and leave the empty.
|
|
|
|
|
|
|
|
|
|
* **Are you running the bot in live or dev mode?**
|
|
|
|
|
|
|
|
|
|
@ -132,22 +134,20 @@ If you want to understand how Random Bunny works or want to debug an issue, you'
|
|
|
|
|
First, fork the Random Bunny repository so that you can make a pull request. Then, clone your fork locally:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
git clone https://gitlab.vylpes.com/<your-gitlab-account>/random-bunny.git
|
|
|
|
|
git clone https://github.com/<your-gitlab-account>/random-bunny.git
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Occasionally, you will want to merge changes in the upstream repository (the official code repo) with your fork.
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
cd Random Bunny
|
|
|
|
|
cd random-bunny
|
|
|
|
|
git checkout master
|
|
|
|
|
git pull https://gitlab.vylpes.com/vylpes/random-bunny.git master
|
|
|
|
|
git pull https://github.com/vylpes/random-bunny.git master
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Manage any merge conflicts, commit them, and then push them to your fork.
|
|
|
|
|
|
|
|
|
|
Go into `Random Bunny` and start the bot in dev mode with `npm run dev` or `node bot dev`
|
|
|
|
|
|
|
|
|
|
> **Note:** If you have `nodemon` installed on your system you can use this during development so it auto restarts when you make code changes. Instead of the commands above you can then run `nodemon bot dev`.
|
|
|
|
|
Go into `random-bunny` and build using `yarn build`.
|
|
|
|
|
|
|
|
|
|
#### Pull Requests
|
|
|
|
|
|
|
|
|
|
@ -309,21 +309,21 @@ Unsure where to begin contributing to Random Bunny? You can start by looking thr
|
|
|
|
|
|
|
|
|
|
#### Prerequisites
|
|
|
|
|
|
|
|
|
|
In order to download necessary tools, clone the repository, and install dependencies via `npm` you need network access.
|
|
|
|
|
In order to download necessary tools, clone the repository, and install dependencies via `yarn` you need network access.
|
|
|
|
|
|
|
|
|
|
You'll need the following tools:
|
|
|
|
|
|
|
|
|
|
* Git
|
|
|
|
|
* NodeJS
|
|
|
|
|
* Yarn
|
|
|
|
|
|
|
|
|
|
Install and build all of the dependencies using `npm`
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
cd Random Bunny
|
|
|
|
|
npm install
|
|
|
|
|
cp config.json.template config.json
|
|
|
|
|
cd random-bunny
|
|
|
|
|
yarn install
|
|
|
|
|
```
|
|
|
|
|
And then use your text editor of choice to fill in the `config.json` file.
|
|
|
|
|
And then use your text editor of choice to fill in the `.env` file.
|
|
|
|
|
|
|
|
|
|
#### Build and Run
|
|
|
|
|
|
|
|
|
|
@ -332,22 +332,20 @@ If you want to understand how Random Bunny works or want to debug an issue, you'
|
|
|
|
|
First, fork the Random Bunny repository so that you can make a pull request. Then, clone your fork locally:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
git clone https://gitlab.vylpes.com/<your-gitlab-account>/random-bunny.git
|
|
|
|
|
git clone https://github.com/<your-github-account>/random-bunny.git
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Occasionally, you will want to merge changes in the upstream repository (the official code repo) with your fork.
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
cd Random Bunny
|
|
|
|
|
cd random-bunny
|
|
|
|
|
git checkout master
|
|
|
|
|
git pull https://github.com/getgravitysoft/random-bunny.git master
|
|
|
|
|
git pull https://github.com/vylpes/random-bunny.git master
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Manage any merge conflicts, commit them, and then push them to your fork.
|
|
|
|
|
|
|
|
|
|
Go into `Random Bunny` and start the bot in dev mode with `npm run dev` or `node bot dev`
|
|
|
|
|
|
|
|
|
|
> **Note:** If you have `nodemon` installed on your system you can use this during development so it auto restarts when you make code changes. Instead of the commands above you can then run `nodemon bot dev`.
|
|
|
|
|
Go into `random-bunny` and build using `yarn build`.
|
|
|
|
|
|
|
|
|
|
#### Pull Requests
|
|
|
|
|
|
|
|
|
|
|