Getting started

Learn how to install MateBot on your computer.

Welcome to MateBot installation guide! This documentation will walk you through the process of installing MateBot on your computer. Before we begin, please make sure that you have Node.js installed on your machine. We recommend using Node.js version 16 or higher.

You can follow the same step to install on Termux (Android) and other Linux servers.

Step 1: Install MateBot

To install MateBot, run the following command in your terminal:

npm i -g matebot

This will install MateBot globally on your machine.

Step 2: Verify Installation

To verify that MateBot has been installed successfully, run the following command in your terminal:

matebot --version

This will display the version of MateBot that you have installed.

Step 3: Start MateBot

To start MateBot, run the following command in your terminal:

matebot init

This will prompt you to enter PostgreSQL database credentials. After you enter the details, it will save it to .env file in current working directory. Next, MateBot server will start running, the default port is 8080.

If you want to create a free PostgreSQL server, you can go with ElephantSQL.

Last updated