1
Fork 0
mirror of https://github.com/Steffo99/greed.git synced 2024-11-21 21:44:19 +00:00

Update the README

This commit is contained in:
Steffo 2020-06-29 03:40:01 +02:00
parent 3f05a1b7e2
commit cb909599ec
Signed by: steffo
GPG key ID: 896A80F55F7C97F0

112
README.md
View file

@ -1,9 +1,15 @@
# greed # Greed
A [customizable](/config/template_config.ini), [multilanguage](/strings) Telegram shop bot with [Telegram Payments support](https://core.telegram.org/bots/payments)! A [customizable](/config/template_config.ini), [multilanguage](/strings) Telegram shop bot with [Telegram Payments support](https://core.telegram.org/bots/payments)!
![](https://img.shields.io/badge/version-beta-blue.svg) ![](https://img.shields.io/badge/version-beta-blue.svg)
## Demo
Send a message to [@greedtestbot](https://t.me/greedtestbot) on Telegram to view a demo of the bot in action!
Use the special credit card number `4242 4242 4242 4242` to add unlimited credit to your account.
## Requirements ## Requirements
* [Python 3.6 (or higher)](https://www.python.org/) * [Python 3.6 (or higher)](https://www.python.org/)
@ -14,53 +20,103 @@ A [customizable](/config/template_config.ini), [multilanguage](/strings) Telegra
* _Optional: a [git client](https://git-scm.com/)_ * _Optional: a [git client](https://git-scm.com/)_
* _Optional: a [sentry.io](https://sentry.io) token_ * _Optional: a [sentry.io](https://sentry.io) token_
Consider renting a VPS to host the bot on
## Installation ## Installation
1. Download the project files through `git clone https://github.com/Steffo99/greed.git` (recommended) or [this link](https://github.com/Steffo99/greed/archive/master.zip). This installation procedure assumes you have `python3.8` installed on an Ubuntu server. If you have a different version installed,
2. Install the project requirements with `pip install -r requirements.txt`
3. _Optional: run `pip install coloredlogs` to have colored logging output._ 1. Download the project files by running:
3. Run `python -OO core.py` to generate the configuration file. ```bash
4. Open the config folder and edit the `config.ini` file following the contained instructions. git clone https://github.com/Steffo99/greed.git
Ensure the `is_template` field is set to `no`. ```
5. Run `python -OO database.py` to generate the database tables.
6. _Optional: customize the `strings.py` file_ 2. Create a new virtualenv:
7. Run `python -OO core.py` again to run the bot. ```bash
8. Open Telegram, and send a `/start` command to your bot to be promoted to administrator. virtualenv -p python3.8 venv
```
3. Activate the virtualenv:
```bash
source venv/bin/activate
```
4. Install the project requirements:
```bash
pip install -r requirements.txt
```
5. _Optional:_ For colored output, install [coloredlogs](https://pypi.org/project/coloredlogs/):
```bash
pip install coloredlogs
```
6. Generate the configuration file:
```bash
python -OO core.py
```
7. Edit the configuration file to your preferences:
```bash
nano config/config.ini
```
Ensure the `is_template` field is set to `no`.
Press **Ctrl+X** and then two times **Enter** to save and quit.
8. Generate the database:
```bash
python -OO database.py
```
9. _Optional:_ customize the files in the `strings` folder for custom messages.
10. Start the bot:
```bash
python -OO core.py
```
11. Open Telegram, and send a `/start` command to your bot to be promoted to 💼 Manager.
12. _Optional:_ Stop the bot, and start it in a `screen` so it can keep running even after you close the console window:
```bash
screen venv/bin/python -OO core.py
```
To safely detach the screen, press Ctrl+A and then Ctrl+D.
## Usage ## Usage
All the bot features are available through Telegram. All features can be accessed through the Telegram bot chat.
As the administrator, you can add new products, check the placed orders, create new transactions and generate .csv log files.
As a 💼 Manager, you can add new products, check the placed orders, create new transactions and generate .csv log files.
You can also add additional 💼 Managers.
Users will be able to add credit to their wallet, place orders and contact you in case they require assistance. Users will be able to add credit to their wallet, place orders and contact you in case they require assistance.
## Updating ## Updating
### Through `git` To update the bot, run the following commands:
If you downloaded `greed` through `git`, you can update it by running: ```bash
```
git stash git stash
git pull git pull
git stash pop git stash pop
``` ```
### By redownloading the zip file ## Documentation and help
If you downloaded `greed` through the zip archive, you can update it by redownloading [the latest version](https://github.com/Steffo99/greed/archive/master.zip) and by moving your `config.ini` and `database.sqlite` (if applicable) files to the new folder.
## Documentation
`greed` currently does not have a documentation page, but you can try to read the [paper](https://docs.google.com/document/d/1f4MKVr0B7RSQfWTSa_6ZO0LM4nPpky_GX_qdls3EHtQ/edit?usp=sharing) (in Italian) I wrote for my final Scuola Superiore exam about it.
## Help!
If you find a bug, have an idea for a new feature or just require help with `greed`, please [post an issue](https://github.com/Steffo99/greed/issues/new) on GitHub, or, if GitHub is blocked in your country, join [the Telegram group](https://t.me/greed_project) and send a message there. If you find a bug, have an idea for a new feature or just require help with `greed`, please [post an issue](https://github.com/Steffo99/greed/issues/new) on GitHub, or, if GitHub is blocked in your country, join [the Telegram group](https://t.me/greed_project) and send a message there.
If you can read Italian, you can try to read the [paper](https://docs.google.com/document/d/1f4MKVr0B7RSQfWTSa_6ZO0LM4nPpky_GX_qdls3EHtQ/edit?usp=sharing) I wrote about greed for my final High School exam.
If you are proficient in Python, you can also try reading the code. Most of the bot interactions can be found in the [`worker.py`](worker.py) file, so try to have a look there.
## Forks ## Forks
> Please note that @Steffo99, the developer of `greed`, does not endorse any of these forks. Some people made a copy of Greed and added or changed some things to it (they made a _fork_).
These forks are listed below.
> Please note that @Steffo99, the main developer of `greed`, does not endorse any of these forks.
### Bitcoin - Blockonomics ### Bitcoin - Blockonomics
[DarrenWestwood](https://github.com/DarrenWestwood) is currently maintaining a [`greed`](https://github.com/DarrenWestwood/greed) fork with **Bitcoin support** through [Blockonomics](https://www.blockonomics.co/). [DarrenWestwood](https://github.com/DarrenWestwood) is currently maintaining a [`greed`](https://github.com/DarrenWestwood/greed) fork adding **Bitcoin support** through [Blockonomics](https://www.blockonomics.co/).