First Steps

Step 1: Cloning the GitHub Repository

Before using the following command, make sure you have installed git on your machine. A install guide is in this documentation.

Open a new terminal in your code editor and type in:

git clone https://github.com/cptcr/nexus.git

This will clone all files into a new folder which is named 'nexus'.

The picture shows the git command and the cloned files.

Now we want to move into our bots directory. To do this, simply type the following command into your console:

cd nexus

Step 2: Installing required dependencies

Go to your terminal and type in this command:

npm i

This command installs every dependecy from package.json. If there are some warnings, you can ignore them. Most of them will be fixxed in the next step.

Step 3: Updating dependencies

To fix most created errors, run the following command in your terminal:

npm update --list

This command will update all of your dependencies to their latest versions.

Step 4: The first start

Yes, finally you can start the bot. To do this run node . in the terminal. Because its the first start, you will be prompted to fill in some informations. You can type anything in there. You can change it later in the created .env file.

This is how your console should look like.

As you can see, in ./.env there is everything you filled into the startup questions. A documentation for the .env file is on the next page.