feat: replace Flask backend with Node.js/Express (#269)

* feat: migrate Software Discovery Tool from Flask to Node.js/Express

- replace Flask backend with Express + MySQL API implementation

- move distro mapping to a single JSON source of truth

- restrict CORS via ALLOWED_ORIGINS and add backend tests

- add Node.js database build script and update docs

- remove deprecated Flask source tree

Signed-off-by: TusharB-07 <tusharnbiswas07@gmail.com>

* fix: add "type":"module", restore config_build.py, and update Installation.md

---------

Signed-off-by: TusharB-07 <tusharnbiswas07@gmail.com>

Author: TusharB-07

.DS_Store

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: ssh and git module update
-      uses: appleboy/ssh-action@master
+      uses: appleboy/ssh-action@v1.0.3
       with:
         host: ${{ secrets.HOST }}
         username: ${{ secrets.USERNAME }}

.env.example

@@ -1,3 +1,11 @@
 *.pyc
 .env
 src/config/supported_distros.py
+node_modules/
+react-frontend/node_modules/
+backend/node_modules/
+react-frontend/build/
+log/
+venv/
+node_modules/
+backend/node_modules/

.github/workflows/updatesubmodules.yml

@@ -10,12 +10,83 @@ Welcome to the Software Discovery Tool! This tool is designed to help you discov
 
 To get started with the Software Discovery Tool, let's take a quick tour of the project and its repositories.
 
-| Repository                                                                                               | Description                                                                                                                                                                                                                                                                                                                                                                                                                                         |
-| -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [Software Discovery Tool](https://github.com/openmainframeproject/software-discovery-tool)               | The main repository of the Software Discovery Tool contains the core functionalities and codebase of the tool. It enables you to search and discover open source software for `zArchitecture/s390x`. You'll find the source code, documentation, and guidelines for contributing to the project in this repository.                                                                                                                                 |
-| [Software Discovery Tool Data](https://github.com/openmainframeproject/software-discovery-tool-data)     | The Software Discovery Tool Data repository holds the necessary data for the software available in the tool. It contains information such as the names and versions of the software that you can discover using the Software Discovery Tool. This data is regularly updated to provide you with the most comprehensive and up-to-date software inventory.                                                                                           |
+| Repository | Description |
+| ---------- | ----------- |
+| [Software Discovery Tool](https://github.com/openmainframeproject/software-discovery-tool) | The main repository of the Software Discovery Tool contains the core functionalities and codebase of the tool. It enables you to search and discover open source software for `zArchitecture/s390x`. You'll find the source code, documentation, and guidelines for contributing to the project in this repository. |
+| [Software Discovery Tool Data](https://github.com/openmainframeproject/software-discovery-tool-data) | The Software Discovery Tool Data repository holds the necessary data for the software available in the tool. It contains information such as the names and versions of the software that you can discover using the Software Discovery Tool. This data is regularly updated to provide you with the most comprehensive and up-to-date software inventory. |
 | [Software Discovery Tool Deploy](https://github.com/openmainframeproject/software-discovery-tool-deploy) | The Software Discovery Tool Deploy repository serves as the deployed version of the main Software Discovery Tool repository. It utilizes the main repository as a submodule and integrates the data repository as a sub-submodule. This deployment repository enables you to quickly set up and run the Software Discovery Tool in your environment. Read more about it [here](https://gist.github.com/rachejazz/de39c09612788635d5d0f491dcf8571a). |
 
+## Local Development Setup
+
+To run the Software Discovery Tool locally for development:
+
+### 1. Prerequisites
+- Node.js (v18+) and npm
+- MariaDB or MySQL server
+- Python 3 (only if you need to run `bin/package_build.py`)
+
+### 2. Database Setup
+1. Create a database (e.g., `sdtDB`) and a user with `SELECT` permissions.
+2. Clone the data submodules:
+   ```bash
+   git submodule update --init --recursive
+   ```
+3. Install root dependencies:
+   ```bash
+   npm install
+   ```
+4. (Optional) Fetch additional distro data (requires Python):
+   ```bash
+   python3 bin/package_build.py debian
+   ```
+5. Initialize the database schema and populate data:
+   ```bash
+   node bin/database_build.js
+   ```
+   *Note: Use a privileged database user (like root) when prompted to create tables. This script uses the database configuration from `backend/.env`.*
+
+### 3. Backend Setup
+1. Navigate to the `backend` directory:
+   ```bash
+   cd backend
+   ```
+2. Install dependencies:
+   ```bash
+   npm install
+   ```
+3. Configure environment:
+   Copy `backend/.env.example` to `backend/.env` and fill in your database credentials:
+   ```bash
+   cp .env.example .env
+   ```
+   *Note: Set `ALLOWED_ORIGINS` to your frontend URL (e.g., `http://localhost:3000`) to enable CORS.*
+4. Start the backend:
+   ```bash
+   npm start
+   ```
+
+### 4. Frontend Setup
+1. Navigate to the `react-frontend` directory:
+   ```bash
+   cd react-frontend
+   ```
+2. Install dependencies:
+   ```bash
+   npm install
+   ```
+3. Configure environment:
+   Copy `react-frontend/.env.example` to `react-frontend/.env`:
+   ```bash
+   cp .env.example .env
+   ```
+   Ensure `REACT_APP_API_URL` points to your backend (default `http://localhost:5000`).
+4. Start the frontend:
+   ```bash
+   npm start
+   ```
+
+The application will be available at `http://localhost:3000`.
+
 ## Contributing
 
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

.gitignore

@@ -0,0 +1,9 @@
+# Database Configuration
+DB_HOST=localhost
+DB_USER=sdtreaduser
+DB_PASSWORD=UPDATEME
+DB_NAME=sdtDB
+
+# Server Configuration
+PORT=5000
+ALLOWED_ORIGINS=http://localhost:3000

README.md

@@ -0,0 +1,13 @@
+FROM node:20-slim
+
+WORKDIR /app
+
+COPY package*.json ./
+
+RUN npm install --production
+
+COPY . .
+
+EXPOSE 5000
+
+CMD ["npm", "start"]

backend/.env.example

@@ -0,0 +1,11 @@
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const distrosPath = path.join(__dirname, '..', 'config', 'distros.json');
+export const SUPPORTED_DISTROS = JSON.parse(fs.readFileSync(distrosPath, 'utf8'));
+
+export const MAX_RECORDS_TO_SEND = 100;