Requirements
The following is a list of requirements needed in terms of software applications and tools to properly execute HorizonGram.
Telegram account
You can create a Telegram account by downloading the Telegram application on your smartphone. You need a phone number.
- Android: you can find it on Play Store
- Apple: you can find it on App Store
Firebase account
You can create a Firebase account by logging in with a Google account. You need a Google account.
- Firebase: go to the platform
Node.js, Npm
Node.js is a JavaScript runtime used to execute HorizonGram server code.
HorizonGram was developed on Node.js v18.19.1 and Npm v10.8.3.
HorizonGram might also work on earlier versions of Node.js, but it has not been tested. You can open an issue on the repository to report that it works with an older version of Node.js.
Note
From this GitHub issue, the minimum working and tested version of Node.js for HorizonGram is v14.
-
Windows
Install WSL:
wsl --install -d Ubuntu
- Setup username and password
To run the server you will need to use WSL. -
Linux
Execute the following commands:
sudo apt install nodejs
sudo apt install npm
node -v
npm -v
-
Apple
Install Homebrew:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
echo "export PATH=/opt/homebrew/bin:$PATH" >> ~/.zprofile && source ~/.zprofile
brew install node
node -v
npm -v
Python
This is an optional step, it must be followed if you want to use the HorizonGram shortcuts, which are files that allow you to start the server and switch profiles with a single click.
You can install Python from here.
Restart your computer after Python installation.