Hamster is a Python-based project designed to collect hamster-coins 🎉. This guide will help you clone, set up, and run the project on your local machine.
- Python 3.x
- Git
First, clone the repository to your local machine using the following command:
git clone https://github.com/RoseGoli/Hamster.git
cd Hamster
It's recommended to create a virtual environment to manage dependencies. You can create and activate a virtual environment using the following commands:
For Unix/macOS:
python3 -m venv venv
source venv/bin/activate
For Windows:
python -m venv venv
venv\Scripts\activate
With the virtual environment activated, install the required dependencies:
pip install -r requirements.txt
Copy the example environment configuration file and edit it as necessary:
cp .env.example .env
Open the .env
file and configure the necessary environment variables.
add the following variables with their respective values:
API_ID = your_api_id
API_HASH = your_api_hash
TG_TOKEN = your_tg_token
OWNERS = [owner1,owner2]
Make sure to replace your_api_id, your_api_hash, your_tg_token, and owners with the actual values.
Finally, run the main script to start the project:
python main.py
Feel free to modify the sections like "Overview", "Contributing" and "Contact" according to your specific project details.