From c99b63f7102c2fabd0115d653fcf37e40b109e00 Mon Sep 17 00:00:00 2001
From: alikhere <alikhurshidhere@gmail.com>
Date: Sun, 16 Feb 2025 21:25:10 +0530
Subject: [PATCH] docs: add missing INSTALLATION.md file for local setup

Signed-off-by: alikhere <alikhurshidhere@gmail.com>
---
 INSTALLATION.md | 86 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 86 insertions(+)
 create mode 100644 INSTALLATION.md

diff --git a/INSTALLATION.md b/INSTALLATION.md
new file mode 100644
index 0000000..8288b6d
--- /dev/null
+++ b/INSTALLATION.md
@@ -0,0 +1,86 @@
+# Installation Guide for hub.microcks.io
+
+This guide will walk you through the installation and setup of the **Microcks Hub** project. You'll learn how to set up the **frontend** and **backend** locally, as well as how to contribute to the project.
+
+## Prerequisites
+
+Before you begin, make sure you have the following installed:
+
+- **Node.js** (v14.x or above)
+- **npm** (comes with Node.js)
+- **Docker** (if you want to use Docker for setup)
+- **Git** (for cloning the repository)
+
+## Clone the Repository
+
+1. Fork the repository from [Microcks Hub GitHub](https://github.com/microcks/hub.microcks.io).
+2. Clone the repository to your local machine:
+   
+   ```bash
+   git clone https://github.com/YOUR_USERNAME/hub.microcks.io.git
+   cd hub.microcks.io
+   ```
+
+## Backend Setup
+
+1. Navigate to the Backend Directory:
+   
+   ```bash
+   cd server
+   ```
+
+2. Install Backend Dependencies:
+   
+   ```bash
+   npm install
+   ```
+
+3. Start the Backend Server:
+   
+   ```bash
+   npm run start
+   ```
+
+   The backend server will start on [http://localhost:4000](http://localhost:4000).
+
+4. Verify the Backend:
+   
+   If everything is set up correctly, you should see the message:
+   
+   ```
+   Express server listening on port 4000
+   Connected to the in-memory SQLite database.
+   ```
+
+## Frontend Setup
+
+1. Navigate to the Frontend Directory:
+   
+   ```bash
+   cd ../frontend
+   ```
+
+2. Install Frontend Dependencies:
+   
+   ```bash
+   npm install
+   ```
+
+3. If you are using Node.js v17+, you may encounter issues related to OpenSSL. To resolve this, set the following environment variable before running the frontend:
+   
+   ```bash
+   export NODE_OPTIONS=--openssl-legacy-provider
+   ```
+
+   This will enable legacy support for OpenSSL.
+
+4. Start the Frontend Development Server:
+   
+   ```bash
+   npm start
+   ```
+
+   The frontend will be available at [http://localhost:4200](http://localhost:4200).
+
+## Contributing
+Check out our [CONTRIBUTING](https://github.com/microcks/hub.microcks.io/blob/master/CONTRIBUTING.md) guide for details. All the best! 🚀