Updated README
This commit is contained in:
38
README.md
38
README.md
@@ -1,30 +1,50 @@
|
||||
# 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:
|
||||
|
||||
1. Middleware Source Code
|
||||
2. Dockerfile
|
||||
3. Install & Manage Script
|
||||
3. Install & Manage Scripts
|
||||
|
||||
### Getting Started:
|
||||
Install required dependencies:
|
||||
## Getting Started:
|
||||
|
||||
### Installation:
|
||||
|
||||
#### 1. Install the required dependencies:
|
||||
|
||||
Needed to download and build the docker container.
|
||||
|
||||
```bash
|
||||
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
|
||||
mkdir -p ~/.db-middleware/scripts &&
|
||||
rm -rf ~/.db-middleware/scripts/* &&
|
||||
cd ~/.db-middleware/scripts &&
|
||||
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
|
||||
``` -->
|
||||
|
||||
@@ -54,5 +54,7 @@ ln -sf "$APP_DIR/scripts/manager.sh" "$HOME/.local/bin/db-middleware"
|
||||
export PATH="$HOME/.local/bin:$PATH"
|
||||
source ~/.bashrc
|
||||
|
||||
sudo usermod -aG docker $USER
|
||||
|
||||
# Run the manager.sh script with the "install" argument
|
||||
"$APP_DIR/scripts/manager.sh" install
|
||||
Reference in New Issue
Block a user