diff --git a/README.md b/README.md index 662705b..497f859 100644 --- a/README.md +++ b/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 ``` + diff --git a/scripts/setup.sh b/scripts/setup.sh index ff846aa..b30a20e 100755 --- a/scripts/setup.sh +++ b/scripts/setup.sh @@ -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 \ No newline at end of file