GitBook: [master] 9 pages and 3 assets modified

MrBartusek · gitbook-bot · commit 6fa146e843ff · 2020-11-21T13:01:18.000Z
diff --git a/.gitbook/assets/replacementbot-logo-512-circle.png b/.gitbook/assets/replacementbot-logo-512-circle.png
diff --git a/.gitbook/assets/replacementbot-logo-512.png b/.gitbook/assets/replacementbot-logo-512.png
diff --git a/.gitbook/assets/setup_command.png b/.gitbook/assets/setup_command.png
diff --git a/README.md b/README.md
@@ -1,12 +1,14 @@
 ---
-description: Meet the ReplacementBot
+description: Get to know each other with the ReplacementBot
 ---
 
-# Introduction
+# What is ReplacementBot
 
-### About
+**ReplacementBot** is a feature-rich discord bot to fetch, parse, and display school substitutions right on your discord server!
 
-Meet the ReplacementBot a Discord bot made to make your school life easier. The Bot automatically fetches substitutions from your school website and shows them right on your discord server.
+## Meet the ReplacementBot
+
+* 🧩 **Integrate with everything** that is online. ReplacementBot supports an ever-expanding base of fetchers. You can always create fetcher and submit it to the bot!
 
 ### Invite The Bot to your server
 
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -1,18 +1,25 @@
 # Table of contents
 
-* [Introduction](README.md)
+* [What is ReplacementBot](README.md)
 
-## Setup the bot
+## 📡 Setup the bot
 
 * [Self-Hosting](setup-the-bot/untitled.md)
-* [Begginier Guide](setup-the-bot/begginier-guide.md)
-* [Technical Guide](setup-the-bot/technical-guide.md)
 
-## Using The Bot
+## ✨ Using The Bot
 
 * [Commands](using-the-bot/commands.md)
+* [Built-in fetchers](using-the-bot/built-in-fetchers.md)
 
-## Creating Custom Fetchers
+## ⚙️ Development
 
-* [Untitled](creating-custom-fetchers/untitled.md)
+* [Fetchers Introduction](development/fetchers-introduction.md)
+* [Fetcher Guidelines](development/fetcher-guidelines.md)
+* [How to Create a Fetcher](development/create-and-fetcher.md)
+
+## ✋ contribute
+
+* [Contributing Guidelines](contribute/contributing-guidelines.md)
+* [Report a Bug](https://github.com/ReplacementBot/ReplacementBot)
+* [Suggest a Feature](https://github.com/ReplacementBot/ReplacementBot)
 
diff --git a/contribute/contributing-guidelines.md b/contribute/contributing-guidelines.md
@@ -0,0 +1,24 @@
+---
+description: A guide how to contribute to the project
+---
+
+# Contributing Guidelines
+
+**ReplacementBot is an Open Source Project** 💞 That means you can work to improve it. We greatly appreciate any work contributed, no matter how small! Pull Requests and Issues or Feature Requests are welcome ❤ 
+
+### Reporting Issues and Feature Requests
+
+If you find any bug or want something to be added to ReplacementBot please create an [issue](https://github.com/ReplacementBot/ReplacementBot/issues). We are offering a couple of templates to choose from so read their descriptions to chose a good one 😎 
+
+### Pull Request Process
+
+If you want to make a codding contribution please make a pull request. If you don't know how to use Git and Github please reefer to [getting started guide](https://docs.github.com/en/github/getting-started-with-github). In ReplacementBot repository your pull request goes throught the following process:
+
+1. Follow the [Setup Guide](%7B%7Bsite.baseurl%7D%7D/setup) to run your own fork and local instance of the bot.
+2. Make the changes
+3. Check if everything works correctly. After checking it manually please run automated tests `npm run test` and `npm run lint`
+4. If you can, write tests for changes that you made to don't lower coverage. If you don't know how to write tests please use `test.todo('Add tests for something blah blah')` 
+5. Create a Pull Request 
+6. CI will automatically check your PR. It will run build, testing, and linting tests
+7. Wait for a maintainer to review and merge your PR 🎉 
+
diff --git a/development/create-and-fetcher.md b/development/create-and-fetcher.md
@@ -0,0 +1,2 @@
+# How to Create a Fetcher
+
diff --git a/development/fetcher-guidelines.md b/development/fetcher-guidelines.md
@@ -0,0 +1,2 @@
+# Fetcher Guidelines
+
diff --git a/development/fetchers-introduction.md b/development/fetchers-introduction.md
@@ -0,0 +1,2 @@
+# Fetchers Introduction
+
diff --git a/setup-the-bot/untitled.md b/setup-the-bot/untitled.md
@@ -1,4 +1,65 @@
 # Self-Hosting
 
-Self-Hosting the bot can be very challenging or trivial for you depending on the level of your technical skills. This article will help to choose which guide to chose when setting up your instance of the bot.
+If you want to work on bot or host it somewhere you can setup it with this guide
+
+### First of all, Bot 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. There are couple of good resources that will help you out
+
+* [Setting up a bot application](https://discordjs.guide/preparations/setting-up-a-bot-application.html)
+* [Adding your bot to servers](discordjs.guide/preparations/adding-your-bot-to-servers.html)
+
+### Local Setup Recommended
+
+#### 1 - Install Required Software:
+
+* [GIT](https://git-scm.com) \(GUI such [GitHub Desktop](https://desktop.github.com) can be helpful\)
+* [Node.JS](https://nodejs.org)
+
+#### 2 - 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
+```
+
+#### 3 - 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
+```
+
+#### 4 - That's It!
+
+You can now run bot anytime by running
+
+```bash
+npm start
+```
+
+### Gitpod - Simple Cloud Development
+
+If you don't want to mess with setup on local machine you can work on bot in the cloud in one click! Gitpod will serve you pre-build workspace in couple of seconds! **Note**: Free version allow for **50 hours / month** if you would like to work more, consider [Upgrade](https://www.gitpod.io/pricing/) or Manual Setup
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/ReplacementBot/ReplacementBot)
+
+### Heroku - Simple Cloud Hosting
+
+You can easily setup bot to work 24/7 with heroku! Be sure to enter bot token when deploying, you can get it from the step above. After setup you need to disable `web` dyno and enable `woker` dyno from **Resources** tab or, your bot will [keep crashing](https://github.com/ReplacementBot/ReplacementBot/issues/60). This method require [ENV Configuration](https://replacementbot.github.io/docs/configuration.html#environmental-variable-env) if you want to use config.
+
+[![Heroku Deploy](https://www.herokucdn.com/deploy/button.svg)](https://www.heroku.com/deploy/?template=https://github.com/ReplacementBot/ReplacementBot)
 
diff --git a/using-the-bot/built-in-fetchers.md b/using-the-bot/built-in-fetchers.md
@@ -0,0 +1,2 @@
+# Built-in fetchers
+
