Files
db-middleware/README.md

61 lines
1.2 KiB
Markdown

# 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 Scripts
## 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
```
[Optional] Install Docker build-kit:
```bash
sudo apt-get docker-buildx -y
```
#### 2. Run the setup script:
Add your user to the docker group and login again:
```bash
sudo usermod -aG docker $USER && sudo su - $USER
```
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
```
<!-- #### 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
``` -->