Innopolis University DevOps Playground
Skip to content
Snippets Groups Projects
Commit 19716349 authored by --show-origin's avatar --show-origin
Browse files

Finished README

parent 5188b930
2 merge requests!12Huge update: now bot support formulas, the messages have emojis.,!10Finished README
# Zakat Barakat
# Zakat Barakat ☪️
The project lives here: [t.me/zakat_calculator_bot](https://t.me/zakat_calculator_bot)
The project lives here: [t.me/zakat_calculator_bot](https://t.me/zakat_calculator_bot) 🔗
## About project
An online platform on islamic finances that includes:
- Calculator of Zakat
- Calculator of Zakat with transparency of calculations (i.e. user can see how zakat is calculated for each type of
- property)
- Telegram WebApp where people can learn more about islamic finances (*developing*)
- LLM model that can give unbiased answers on custom questions abous islamic finances (*will be added in feature*)
## Demos:
<img src="https://i.ibb.co/M1BXfCV/project-screenshot.png" alt="project-screenshot" width="300px">
<img src="https://i.ibb.co/7r6Zv7S/project-screenshot-2.png" alt="project-screenshot-2" width="300px">
## Deploying
1) Fork the project and clone it using `git clone`
2) Set up the virtual environment and install the dependecies. The commands for powershell may look like these:
2) Create the `.env` file in the root directory and fill it according to `.env.example`
3) Set up the virtual environment and install the dependencies. The commands for powershell may look like these:
```powershell
python -m venv venv
.\venv\Scripts\activate
pip install -r requirements.txt
```
4) To launch the project, set `PYTHONPATH` to the root directory (to ensure imports work in `bot/__main__.py`)
```powershell
> cd <cloned-directory>
> python -m venv venv
> .\venv\Scripts\activate
> set PYTHONPATH=%CD%
> pip install -r requirements.txt
$env:PYTHONPATH = (Get-Location).Path
bot/__main__.py
```
\ No newline at end of file
3) Create the `.env` file in the root directory and fill it according to `.env.example`
4) Launch `bot/__main__.py` and that's it!
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment