GitBook: [master] 9 pages modified

Author: MrBartusek

README.md

@@ -16,7 +16,7 @@ Unfortunately, the current version of the bot doesn't allow for us to host one p
 
 ### Self-Host the Bot
 
-{% page-ref page="setup-the-bot/self-hosting.md" %}
+{% page-ref page="setup-the-bot/own-instancie-setup.md" %}
 
 
 

SUMMARY.md

@@ -4,13 +4,22 @@
 
 ## 📡 Setup the bot
 
-* [Self-Hosting](setup-the-bot/self-hosting.md)
+* [Own Instance Setup](setup-the-bot/own-instancie-setup.md)
+* [Setup Discord App](https://discordpy.readthedocs.io/en/latest/discord.html)
+* [Manual Setup](setup-the-bot/manual-setup.md)
+* [Cloud Development with Gitpod](setup-the-bot/cloud-development-with-gitpod.md)
+* [Hosting with Heroku](setup-the-bot/hosting-with-heroku.md)
+* [Hosting with PM2](setup-the-bot/hosting-with-pm2.md)
 
 ## ✨ Using The Bot
 
 * [Commands](using-the-bot/commands.md)
 * [Built-in fetchers](using-the-bot/built-in-fetchers.md)
 
+## 🗳️ configure the bot
+
+* [Untitled](configure-the-bot/untitled.md)
+
 ## ⚙️ Development
 
 * [Fetchers Introduction](development/fetchers-introduction.md)

configure-the-bot/untitled.md

@@ -0,0 +1,2 @@
+# Untitled
+

setup-the-bot/cloud-development-with-gitpod.md

@@ -0,0 +1,12 @@
+# Cloud Development with Gitpod
+
+{% hint style="info" %}
+Before choosing an approach you need to [register the discord app!](https://discordpy.readthedocs.io/en/latest/discord.html)
+{% endhint %}
+
+If you don't want to mess with setup on the local machine you can work on the bot in the cloud in one click! **Gitpod** will serve you pre-build workspace in a couple of seconds! Just click the button and everything will be set up for you!
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/ReplacementBot/ReplacementBot)
+
+
+

setup-the-bot/hosting-with-heroku.md

@@ -0,0 +1,18 @@
+# Hosting with Heroku
+
+{% hint style="info" %}
+Before choosing an approach you need to [register the discord app!](https://discordpy.readthedocs.io/en/latest/discord.html)
+{% endhint %}
+
+We provide full support for **Heroku**. It's an extremely easy to use cloud hosting service, and **free tier is enough** to keep the bot running. This guide will show you how to set up the hosting for the bot in a couple of minutes.
+
+### Register a [Heroku Account](https://heroku.com)
+
+If you don't have one, please register a free account.
+
+### Use Heroku Deploy Button
+
+[![Heroku Deploy](https://www.herokucdn.com/deploy/button.svg)](https://www.heroku.com/deploy/?template=https://github.com/ReplacementBot/ReplacementBot)
+
+
+

setup-the-bot/hosting-with-pm2.md

@@ -0,0 +1,6 @@
+# Hosting with PM2
+
+{% hint style="info" %}
+Before choosing an approach you need to [register the discord app!](https://discordpy.readthedocs.io/en/latest/discord.html)
+{% endhint %}
+

setup-the-bot/manual-setup.md

@@ -0,0 +1,50 @@
+---
+description: Manual setup is the best approach when you run the bot on your local machine
+---
+
+# Manual Setup
+
+{% hint style="info" %}
+Before choosing an approach you need to [register the discord app!](https://discordpy.readthedocs.io/en/latest/discord.html)
+{% endhint %}
+
+### ⬇ Install Required Software:
+
+* [GIT](https://git-scm.com) \(GUI such [GitHub Desktop](https://desktop.github.com) can be helpful\)
+* [Node.JS](https://nodejs.org)
+
+### 🗳 Clone The Repository
+
+To clone the repository, either use the Git GUI if you have one installed or enter the following commands:
+
+```bash
+# if you don't want to contribute, just host the bot, nothing else
+git clone https://github.com/ReplacementBot/ReplacementBot.git
+cd ReplacementBot
+```
+
+If you want to contribute, first [fork the original repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) and clone the **forked** repository into your local machine. If you don't do this, you will not be able to make commits or change any files.
+
+```bash
+# if you want to contribute, make changes and work on the bot
+git clone https://github.com/<username>/ReplacementBot.git
+cd ReplacementBot
+```
+
+### ⚙ **Install Dependencies And Build Project**
+
+That step will setup files on your local machine that are not copied from the repository.
+
+```bash
+npm install
+npm run build
+```
+
+### ✅ That's It!
+
+You can now run bot anytime by running this command in the project directory
+
+```bash
+npm start
+```
+

setup-the-bot/own-instancie-setup.md

@@ -0,0 +1,48 @@
+---
+description: >-
+  If you wish to setup ReplacementBot to contribute or to host it. This guide
+  will walk you thought how to do it.
+---
+
+# Own Instance Setup
+
+## Setup the Discord Application
+
+To run an instance of any of Discord Bots you must first create the app on [Discord Developer Portal](https://discordapp.com/developers/applications) first. 
+
+## Chose your approach
+
+While setting up bot you may choose a couple of approaches. There are a couple of them but, they are straightforward to choose because of how specific they are. They are, of course, not of all the options you can choose but they are recommended.
+
+* ✅ Recommended Approach
+* ☑ Possible Approach
+* ❌ Not Recommended
+
+| What do you want  to do with the bot | Manual Setup | Heroku | PM2 | Gitpod |
+| :--- | :--- | :--- | :--- | :--- |
+| ✨ Use it  | ☑  | ✅  | ✅  | ❌  |
+| 🔍 Check it out | ❌  | ✅  | ☑  | ❌  |
+| 👨💻 Contribute to it | ✅  | ❌  | ❌  | ☑  |
+
+### ✨ I want to use the bot
+
+If you want to use the bot it would be best it will be up 24/7. You need to put it on the hosting service or craft your own. We provide full support for **Heroku**. It isn't best service but it's extremely easy to use, and **free tier is enough** to keep the bot running. Alternatively, If you have any device that can run all day long like [Raspberry Pi](https://www.raspberrypi.org) you can use **PM2** to handle processes programs on your device easily. 
+
+{% page-ref page="hosting-with-heroku.md" %}
+
+### 🔍 I want to check how the bot is working
+
+If you want to quickly check if ReplacementBot is something that you are looking for you can use **Heroku**, it will handle all the technical stuff and will be the fastest approach.\
+
+{% page-ref page="hosting-with-heroku.md" %}
+
+{% page-ref page="hosting-with-pm2.md" %}
+
+### 👨💻 I want to contribute to the bot
+
+That's great ❤ReplacementBot is Open-Source project hosted on [GitHub](https://github.com/ReplacementBot?type=source). You will probably be interested in the **Manal Setup** on your machine or, you can the cloud development platform - **Gitpod**.
+
+{% page-ref page="manual-setup.md" %}
+
+{% page-ref page="cloud-development-with-gitpod.md" %}
+