Updated README

This commit is contained in:
2025-03-27 01:05:02 +03:00
parent a9f39da9cb
commit ebe2c9b493
2 changed files with 31 additions and 9 deletions

View File

@@ -1,30 +1,50 @@
# Capital Index Database Middleware # Capital Index Database Middleware
## Description:
### About this project:
Database Middleware that handles database's querying and changes monitoring.
Adds an abstraction layer on top of your Database.
### This repo contains: ### This repo contains:
1. Middleware Source Code 1. Middleware Source Code
2. Dockerfile 2. Dockerfile
3. Install & Manage Script 3. Install & Manage Scripts
### Getting Started: ## Getting Started:
Install required dependencies:
### Installation:
#### 1. Install the required dependencies:
Needed to download and build the docker container.
```bash ```bash
sudo apt-get update && sudo apt-get upgrade -y && sudo apt-get install wget git docker.io -y sudo apt-get update && sudo apt-get upgrade -y && sudo apt-get install wget git docker.io -y
``` ```
Add your user to the docker group:
```bash
sudo usermod -aG docker $USER
```
Run the setup script: #### 2. Run the setup script:
This will download & execute the `setup.sh` script.
```bash ```bash
mkdir -p ~/.db-middleware/scripts && mkdir -p ~/.db-middleware/scripts &&
rm -rf ~/.db-middleware/scripts/* &&
cd ~/.db-middleware/scripts && cd ~/.db-middleware/scripts &&
wget -qO setup.sh https://gitea.abdulhade.com/abdulhade/db-middleware/raw/branch/main/scripts/setup.sh && wget -qO setup.sh https://gitea.abdulhade.com/abdulhade/db-middleware/raw/branch/main/scripts/setup.sh &&
bash setup.sh sudo bash setup.sh
``` ```
<!-- #### 3. Add your user to the docker group:
So you don't have to use `sudo` to run the script.
```bash
sudo usermod -aG docker $USER
``` -->

View File

@@ -54,5 +54,7 @@ ln -sf "$APP_DIR/scripts/manager.sh" "$HOME/.local/bin/db-middleware"
export PATH="$HOME/.local/bin:$PATH" export PATH="$HOME/.local/bin:$PATH"
source ~/.bashrc source ~/.bashrc
sudo usermod -aG docker $USER
# Run the manager.sh script with the "install" argument # Run the manager.sh script with the "install" argument
"$APP_DIR/scripts/manager.sh" install "$APP_DIR/scripts/manager.sh" install