Slurpcy / Hyena-Hostable

The customisable and self hostable Hyena.

➜ Hyena Hostable Bot

The new and improved Hyena, the one customisable, and the one you can use however you like.

• Customisable
• Fast
• Easy to use

➜ Support

Join our support & community discord server for any queries or support in general!

➜ Help Us

Become a patron, by simply clicking on this button very appreciated!:

➜ Supporters

➜ How to colaborate here

For any doubts here, contact Donut#4427 please. Follow the steps given below

Step 1: Fork & Clone the repository

$ git clone link-to-my-forked-repository.git hyenabot # usually link will be https://github.com/YourUserName/Hyena-Hostable
$ cd Hyena-Hostable

Step 2: Setup virtual environment This can simply be done by doing the following:

$ virtualenv venv # Linux/mac

$ py -m venv venv # Windows

Step 3: Activating virtual environment and setting up the dependencies

$ source ./venv/bin/activate  # Linux/mac # from root dir

$ venv\Scripts\activate.bat # Windows

Now our virtual env should be activated, time to install the packages & databases.

$ pip install -U -r requirements.txt  # Linux/mac

$ py -m pip install -U -r requirements.txt # Windows

# now creating databases
$ cd src/data
$ python3 create-databases.py

Step 4: Checkout a new branch

$ git checkout -b my-new-feature

Step 5: Code the feature
Pick a feature from the Issues and code it
Am i supposed to tell you how to do this one too?

Step 6: Commit the feature

$ git commit -m "define your feature here"

• For noobs like you (and me) who don't know how to write a commit message:
  
• How to write a proper commit message

Step 7: Push the feature

$ git push origin my-new-feature # branch name should be same as the one you checked out

Step 8: Create a pull request

• Go to the your forked repository
• A button like this will appear, click on it:
  
  
  
  
• Create a pull request like this:
  
  
  
  
• Then Donut will merge the pull request after reviewing