Skip to content

Latest commit

 

History

History
62 lines (42 loc) · 1.53 KB

README.md

File metadata and controls

62 lines (42 loc) · 1.53 KB
Raw

Bossoep 🌳

Open-source Discord bot

About 📘

This repository households the Bossoep Discord bot.

Getting Started 🦜

Prerequisites 📋

  • NodeJS: We recommend using the latest LTS version.
  • Yarn: We recommend using the latest version. (optional, you can run the website local with npm)

Installation 👷

The first step is cloning the repository on your local machine.

git clone https://github.com/HalloSouf/bossoep.git

Navigate through your CLI to the cloned repository and install all dependencies.

cd bossoep

# With yarn
yarn install

# Or with NPM
npm install

After installing the dependencies, you're ready to setup some environment variables. The repository contains a .env.example file which you can rename to .env. In this file you can set for example your client token & ID.

Run project 🚀

Now you have installed all the required dependencies & setting up your environment variables, you are ready to start your development environment on your local machine.

# Build project
yarn build

# With yarn
yarn dev

# Or with NPM
npm run dev

License 📜

This project is licensed under the Public General Apache 2.0 License - see the LICENSE file for details.