ADDED EMOJIS TO THE DOCS, WOW 😯
This commit is contained in:
82
README.md
82
README.md
@@ -1,11 +1,11 @@
|
||||
# Capital Index Database Middleware
|
||||
# 🏦 Capital Index Database Middleware
|
||||
|
||||
## Overview
|
||||
## 📄 Overview
|
||||
|
||||
### About This Project
|
||||
### 💡 About This Project
|
||||
The **Capital Index Database Middleware** provides an abstraction layer for your database, enhancing query management and change monitoring. It streamlines database interactions while ensuring efficient performance and security.
|
||||
|
||||
### Repository Contents
|
||||
### 📁 Repository Contents
|
||||
This repository includes:
|
||||
- **Middleware Source Code** – The core logic for database interaction.
|
||||
- **Dockerfile** – Configuration for containerized deployment.
|
||||
@@ -15,34 +15,34 @@ This repository includes:
|
||||
|
||||
---
|
||||
|
||||
### Table of Content:
|
||||
### 🧭 Table of Content:
|
||||
|
||||
|
||||
- [Capital Index Database Middleware](#capital-index-database-middleware)
|
||||
- [Overview](#overview)
|
||||
- [About This Project](#about-this-project)
|
||||
- [Repository Contents](#repository-contents)
|
||||
- [Table of Content:](#table-of-content)
|
||||
- [Getting Started](#getting-started)
|
||||
- [Installation](#installation)
|
||||
- [Step 1: Install Required Dependencies](#step-1-install-required-dependencies)
|
||||
- [Step 2: Run the Setup Script](#step-2-run-the-setup-script)
|
||||
- [Configuration](#configuration)
|
||||
- [1. API\_PORT](#1-api_port)
|
||||
- [2. CONTAINER\_NAME](#2-container_name)
|
||||
- [3. HAS\_LOCAL\_DBS](#3-has_local_dbs)
|
||||
- [Test your setup](#test-your-setup)
|
||||
- [Using the `status` command:](#using-the-status-command)
|
||||
- [Using the `test_setup` command:](#using-the-test_setup-command)
|
||||
- [Create your first admin user](#create-your-first-admin-user)
|
||||
- [Expose the API](#expose-the-api)
|
||||
- [Using Nginx](#using-nginx)
|
||||
- [Using Apache](#using-apache)
|
||||
- [🏦 Capital Index Database Middleware](#-capital-index-database-middleware)
|
||||
- [📄 Overview](#-overview)
|
||||
- [💡 About This Project](#-about-this-project)
|
||||
- [📁 Repository Contents](#-repository-contents)
|
||||
- [🧭 Table of Content:](#-table-of-content)
|
||||
- [🚀 Getting Started](#-getting-started)
|
||||
- [🛠️ Installation](#️-installation)
|
||||
- [🔧 Step 1: Install Required Dependencies](#-step-1-install-required-dependencies)
|
||||
- [▶️ Step 2: Run the Setup Script](#️-step-2-run-the-setup-script)
|
||||
- [⚙️ Configuration](#️-configuration)
|
||||
- [🔢 API\_PORT](#-api_port)
|
||||
- [📦 CONTAINER\_NAME](#-container_name)
|
||||
- [💾 HAS\_LOCAL\_DBS](#-has_local_dbs)
|
||||
- [✅ Test your setup](#-test-your-setup)
|
||||
- [📊 Using the `status` command:](#-using-the-status-command)
|
||||
- [🧪 Using the `test_setup` command:](#-using-the-test_setup-command)
|
||||
- [👤 Create your first admin user](#-create-your-first-admin-user)
|
||||
- [🌍 Expose the API](#-expose-the-api)
|
||||
- [🌐 Using Nginx](#-using-nginx)
|
||||
- [🅰️ Using Apache](#️-using-apache)
|
||||
- [🚀 Available Commands](#-available-commands)
|
||||
- [🛠️ Source Code Management](#️-source-code-management)
|
||||
- [🚦 App Running](#-app-running)
|
||||
- [👥 User Management](#-user-management)
|
||||
- [⚙️ Configuration](#️-configuration)
|
||||
- [⚙️ Configuration](#️-configuration-1)
|
||||
- [📚 Help](#-help)
|
||||
- [Legal \& Licensing](#legal--licensing)
|
||||
- [⚠️ Important Legal Notice](#️-important-legal-notice)
|
||||
@@ -50,11 +50,11 @@ This repository includes:
|
||||
|
||||
|
||||
|
||||
## Getting Started
|
||||
## 🚀 Getting Started
|
||||
|
||||
### Installation
|
||||
### 🛠️ Installation
|
||||
|
||||
#### Step 1: Install Required Dependencies
|
||||
#### 🔧 Step 1: Install Required Dependencies
|
||||
Before installing, ensure you have the necessary dependencies to download and build the Docker container.
|
||||
|
||||
<details>
|
||||
@@ -115,7 +115,7 @@ sudo apk add --no-cache docker-cli-buildx
|
||||
```
|
||||
</details>
|
||||
|
||||
#### Step 2: Run the Setup Script
|
||||
#### ▶️ Step 2: Run the Setup Script
|
||||
After installing dependencies, configure Docker permissions and run the setup script:
|
||||
|
||||
1. Add your user to the Docker group and re-login:
|
||||
@@ -143,28 +143,28 @@ After installing dependencies, configure Docker permissions and run the setup sc
|
||||
|
||||
---
|
||||
|
||||
## Configuration
|
||||
## ⚙️ Configuration
|
||||
During installation, you will be prompted to configure the following variables:
|
||||
|
||||
### 1. API_PORT
|
||||
### 🔢 API_PORT
|
||||
- Defines the port the middleware listens on.
|
||||
- **Default:** `8080`
|
||||
- Access within your machine: `http://localhost:8080`
|
||||
- Ensure this port is forwarded if external access is required.
|
||||
|
||||
### 2. CONTAINER_NAME
|
||||
### 📦 CONTAINER_NAME
|
||||
- Specifies the name of the Docker container running the middleware.
|
||||
|
||||
### 3. HAS_LOCAL_DBS
|
||||
### 💾 HAS_LOCAL_DBS
|
||||
Determines how the middleware connects to databases:
|
||||
- **Enter `0`** – If all the databases are hosted on a remote server.
|
||||
- **Enter `1`** – If one or more of the database runs on the same machine.
|
||||
|
||||
> **Note:** By default, Docker containers operate on an isolated network. If your database is local, the middleware must be configured to run on the same network to ensure connectivity.
|
||||
|
||||
## Test your setup
|
||||
## ✅ Test your setup
|
||||
|
||||
### Using the `status` command:
|
||||
### 📊 Using the `status` command:
|
||||
|
||||
Check the status of the container
|
||||
|
||||
@@ -218,7 +218,7 @@ Config file loaded successfully.
|
||||
</details>
|
||||
|
||||
|
||||
### Using the `test_setup` command:
|
||||
### 🧪 Using the `test_setup` command:
|
||||
|
||||
If the container is created and running, use the test setup command:
|
||||
|
||||
@@ -237,7 +237,7 @@ Config file loaded successfully.
|
||||
```
|
||||
|
||||
|
||||
## Create your first admin user
|
||||
## 👤 Create your first admin user
|
||||
|
||||
First make sure it is running by calling the `db-middleware start` command.
|
||||
|
||||
@@ -263,7 +263,7 @@ Enter role (admin/user): admin
|
||||
You don't need passwords for this, just the username and role.
|
||||
|
||||
|
||||
## Expose the API
|
||||
## 🌍 Expose the API
|
||||
|
||||
This app currently runs on your local network only, we need to expose it so the data consumer on the Data Analysis product can access it and consume the data it provides.
|
||||
|
||||
@@ -273,7 +273,7 @@ You can use a dedicated domain, or a sub-domain of yours.
|
||||
|
||||
You can use any reverse proxy you prefer, we will guide you through Nginx and Apache.
|
||||
|
||||
### Using Nginx
|
||||
### 🌐 Using Nginx
|
||||
|
||||
Nginx is a great reverse-proxy that supports connection polling and real-time connections like Webhook and Server Site Events.
|
||||
|
||||
@@ -363,7 +363,7 @@ sudo systemctl restart nginx
|
||||
|
||||
> Notice the **s** in http**s**
|
||||
|
||||
### Using Apache
|
||||
### 🅰️ Using Apache
|
||||
|
||||
1. Make sure apache is installed and upgraded
|
||||
|
||||
|
||||
Reference in New Issue
Block a user