GitBook: [master] 6 pages modified

Author: eslachance

README.md

@@ -1,10 +1,3 @@
----
-description: >-
- Starting up with discord.js botmaking? Need a written guide because docs are
- hard and videos are annoying? Boy have we got the solution for you! All for
- the one-time price of $0.00!
----
-
 # Welcome
 
 ## Introduction

first-bot/your-first-bot.md

@@ -1,10 +1,3 @@
----
-description: >-
- In this chapter I'll guide you through the development of a simple bot with
- some useful commands. We'll start with the example we created in the first
- chapter and expand upon it.
----
-
 # Your First Bot
 
 This chapter assumes you've followed the Getting Started chapter and your bot code compiles. Also, I have to repeat: if you don't understand the code you're about to see, coding a bot might not be for you. Go to [CodeAcademy](https://www.codecademy.com/learn/javascript) and learn Javascript.

frequently-asked-questions.md

@@ -1,9 +1,3 @@
----
-description: >-
- In this page, some very basic, frequently-asked questions are answered. If I
- send you here, it means this page has your answer ;)
----
-
 # Frequently Asked Questions
 
 In this page, some very basic, frequently-asked questions are answered. It's important to understand that **these examples are generic** and will most likely not work if you just copy/paste them in your code. You need to **understand** these lines, not just blindly shove them in your code.

getting-started/getting-started-long-version.md

@@ -1,10 +1,3 @@
----
-description: >-
- So, you want to write a bot and you know some JavaScript, or maybe even
- node.js. You want to do cool things like a music bot, tag commands, the whole
- shebang. Well you're at the right place!
----
-
 # Getting Started - Long Version
 
 So, you want to write a bot and you know some JavaScript, or maybe even node.js. You want to do cool things like a music bot, tag commands, random image searches, the whole shebang. Well you're at the right place!

other-guides/env-files.md

@@ -1,23 +1,26 @@
-# `.env` Files and Environment Variables
+# Using Environment Variables
 
-A `.env` file is a type of file that holds environment variables of an application. Environment variables allow you to easily integrate your bot with various online platforms (ex. Heroku), easily split your production and development environment as well as keep important information like your bot token, API tokens and database details secure.
+A `.env` file is a type of file that holds environment variables of an application. Environment variables allow you to easily integrate your bot with various online platforms \(ex. Heroku\), easily split your production and development environment as well as keep important information like your bot token, API tokens and database details secure.
 
 You do not want this information to get out to anyone. And using environment variables in a `.env` file is one of the best ways to secure your information, being preferred over a `config.json` file.
 
 To start out, it's suggested you install the `dotenv` package from NPM. This allows you to easily integrate environment variables into your bot. You may do that via the console. Make sure you are in your bot's root directory. Run this command:
 
 `npm install dotenv`
 
-Once installed, you will need to create a `.env` file. I'll create an example one here (I will be using the `CLIENT_TOKEN` variable from the master branch of discord.js).
+Once installed, you will need to create a `.env` file. I'll create an example one here \(I will be using the `CLIENT_TOKEN` variable from the master branch of discord.js\).
 
-*If using v12 branch of discord.js, use `DISCORD_TOKEN=`.*
-```
+_If using v12 branch of discord.js, use_ `DISCORD_TOKEN=`_._
+
+```text
 CLIENT_TOKEN=[YOUR_BOT_TOKEN]
 OWNER=[YOUR_OWNER_ID]
 PREFIX=[DEFAULT_BOT_PREFIX]
 ```
+
 After you create and update this file, save it and head over to your main file. I will build off of the default Discord.js example code.
-```js
+
+```javascript
 const Discord = require('discord.js');
 // Importing this allows you to access the environment variables of the running node process
 require('dotenv').config();
@@ -48,56 +51,67 @@ client.on('message', message => {
 // Here you can login the bot. It automatically attempts to login the bot with the environment variable you set for your bot token (either "CLIENT_TOKEN" or "DISCORD_TOKEN")
 client.login();
 ```
+
 This is all you will need to get off the ground. Now I will explain why this is important and why you should use environment variables with a `.env` file over a `config.json` file.
 
-## Using Git (ex. GitHub)
+## Using Git \(ex. GitHub\)
+
 If you're going to publish your code with Git to a site like GitHub, then it's imperative you secure information by making sure your `.env` isn't committed to a repository. You may do that using a `.gitignore` file. Simply add the `.env` file to the `.gitignore` file in your local repository.
 
 From there on out, any future commits will ignore that file or any other files or directories in `.gitignore`. You can set up a `.env.example` file in its place, but that's not always necessary.
-```
+
+```text
 .env
 ```
+
 Following this, all users will see in your bot code is `process.env.ENV_VARIABLE` which exposes nothing!
 
 ## Using Heroku
+
 Heroku is a website that allows you to start out and host your applications for free. In this case, your Discord bot. However, Heroku requires that you use environment variables. If you setup your files with the `dotenv` package and required the specific environment variables in your code, then all you have to do is go the environment variables in your Heroku application and add the key and value.
 
 In Heroku, these variables are called "Config Vars". I'm not going to go in-depth here about Heroku, but the same way you setup your `.env` file, you would add in new environment variables in Heroku.
 
 ![Heroku Config Vars](https://i.imgur.com/MSmEO5K.png)
 
 The only way your bot token can be exposed along with other environment variables is if you do one or more of these things:
-- a) You accidentally expose your `.env` file because you didn't add it to `.gitignore`
-- b) You added a collaborator through Heroku. A collaborator has almost full permissions as the app owner
+
+* a\) You accidentally expose your `.env` file because you didn't add it to `.gitignore`
+* b\) You added a collaborator through Heroku. A collaborator has almost full permissions as the app owner
 
 Both a and b can be controlled. It's just you need to be smart.
 
 ## Set environment variables in the start script
+
 When starting your application, either locally on your computer, in a npm start script in your `package.json` or even in a `Dockerfile` you can set what environment your bot should run in.
 
 For example, you may want to run your bot in production on Heroku or Glitch and in development on your computer. You can simply do that via adding new scripts in your `package.json`.
 
 Upon doing `npm init` when you first made your bot, you should have seen a `test` script created. The scripts portion of your `package.json` should look like this if you added nothing.
-```json
+
+```javascript
 "scripts": {
  "test": "echo \"Error: no test specified\" && exit 1",
 },
 ```
 
 Here, you can add multiple scripts. Where going to add a few scripts. `production`, `development`, and `start`.
-```json
+
+```javascript
 "scripts": {
  "test": "echo \"Error: no test specified\" && exit 1",
  "start": "node .",
  "production": "NODE_ENV=production&&npm start",
  "development": "set NODE_ENV=development&&npm start"
 },
 ```
-- To start your bot in a production environment, you would do `npm run production`. This will set `process.env.NODE_ENV` to `production`
-- To start your bot in a development environment, you would do `npm run development`. This will set `process.env.NODE_ENV` to `development`
+
+* To start your bot in a production environment, you would do `npm run production`. This will set `process.env.NODE_ENV` to `production`
+* To start your bot in a development environment, you would do `npm run development`. This will set `process.env.NODE_ENV` to `development`
 
 In your code, you can define what should happen depending on the environment loaded. Here's an example where your bot should only show the stream status if the environment is in `production` when the `ready` event is fired:
-```js
+
+```javascript
 require('dotenv').config();
 
 // process.env.NODE_ENV allows you to get the environment the node process is in
@@ -112,11 +126,13 @@ client.on('ready', () => {
  }
 });
 ```
-Here I make sure that the bot is set to a streaming status only if my node environment is in `production`. I don't want my bot shown as streaming while I'm working on it in a development environment. There is a lot more you can do with this though.
+
+Here I make sure that the bot is set to a streaming status only if my node environment is in `production`. I don't want my bot shown as streaming while I'm working on it in a development environment. There is a lot more you can do with this though.
 
 For example, you can change the `production` and `development` scripts to use entirely different main files if you wish. But I won't get into that here.
 
 If you don't want to use start scripts, you can always set the node environment directly in the command line. Here's how:
+
 ```bash
 # Windows
 SET NODE_ENV=development&&npm start
@@ -130,22 +146,29 @@ NODE_ENV=development&&node app.js
 ```
 
 Either running these commands directly through the command line or in start scripts should work. It's entirely up to you. But for ease of use when deploying your bot, you should use start scripts. So for example, in Heroku, you can add this in your `Procfile`:
-```
+
+```text
 # Heroku will run the bot in production mode
 worker npm run production
 ```
+
 If you're using Glitch, you can add this in your `start` script in your `package.json`:
-```json
+
+```javascript
 "scripts": {
  "test": "echo \"Error: no test specified\" && exit 1",
  "start": "NODE_ENV=production&&node app.js"
 },
 ```
+
 You may need to change the name of the main file depending on what you called it/where it's located in your bot project.
 
 ## More information
+
 Here are some links to more information you can read regarding environment variables and Git if you aren't that familiar with it:
-- [Using Git to share and update code (An Idiot's Guide)](https://anidiots.guide/other-guides/using-git-to-share-and-update-code#ignoring-files)
-- [Working with Environment Variables in Node.js (Twilio Blog)](https://www.twilio.com/blog/2017/08/working-with-environment-variables-in-node-js.html)
-- [`dotenv` NPM](https://www.npmjs.com/package/dotenv)
-- [`dotenv-flow` NPM (Used for multiple `.env` file)](https://www.npmjs.com/package/dotenv-flow)
+
+* [Using Git to share and update code \(An Idiot's Guide\)](https://anidiots.guide/other-guides/using-git-to-share-and-update-code#ignoring-files)
+* [Working with Environment Variables in Node.js \(Twilio Blog\)](https://www.twilio.com/blog/2017/08/working-with-environment-variables-in-node-js.html)
+* [`dotenv` NPM](https://www.npmjs.com/package/dotenv)
+* [`dotenv-flow` NPM \(Used for multiple `.env` file\)](https://www.npmjs.com/package/dotenv-flow)
+