|
| 1 | +# Installation Guide for hub.microcks.io |
| 2 | + |
| 3 | +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. |
| 4 | + |
| 5 | +## Prerequisites |
| 6 | + |
| 7 | +Before you begin, make sure you have the following installed: |
| 8 | + |
| 9 | +- **Node.js** (v14.x or above) |
| 10 | +- **npm** (comes with Node.js) |
| 11 | +- **Docker** (if you want to use Docker for setup) |
| 12 | +- **Git** (for cloning the repository) |
| 13 | + |
| 14 | +## Clone the Repository |
| 15 | + |
| 16 | +1. Fork the repository from [Microcks Hub GitHub](https://github.com/microcks/hub.microcks.io). |
| 17 | +2. Clone the repository to your local machine: |
| 18 | + |
| 19 | + ```bash |
| 20 | + git clone https://github.com/YOUR_USERNAME/hub.microcks.io.git |
| 21 | + cd hub.microcks.io |
| 22 | + ``` |
| 23 | + |
| 24 | +## Backend Setup |
| 25 | + |
| 26 | +1. Navigate to the Backend Directory: |
| 27 | + |
| 28 | + ```bash |
| 29 | + cd server |
| 30 | + ``` |
| 31 | + |
| 32 | +2. Install Backend Dependencies: |
| 33 | + |
| 34 | + ```bash |
| 35 | + npm install |
| 36 | + ``` |
| 37 | + |
| 38 | +3. Start the Backend Server: |
| 39 | + |
| 40 | + ```bash |
| 41 | + npm run start |
| 42 | + ``` |
| 43 | + |
| 44 | + The backend server will start on [http://localhost:4000](http://localhost:4000). |
| 45 | + |
| 46 | +4. Verify the Backend: |
| 47 | + |
| 48 | + If everything is set up correctly, you should see the message: |
| 49 | + |
| 50 | + ``` |
| 51 | + Express server listening on port 4000 |
| 52 | + Connected to the in-memory SQLite database. |
| 53 | + ``` |
| 54 | + |
| 55 | +## Frontend Setup |
| 56 | + |
| 57 | +1. Navigate to the Frontend Directory: |
| 58 | + |
| 59 | + ```bash |
| 60 | + cd ../frontend |
| 61 | + ``` |
| 62 | + |
| 63 | +2. Install Frontend Dependencies: |
| 64 | + |
| 65 | + ```bash |
| 66 | + npm install |
| 67 | + ``` |
| 68 | + |
| 69 | +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: |
| 70 | + |
| 71 | + ```bash |
| 72 | + export NODE_OPTIONS=--openssl-legacy-provider |
| 73 | + ``` |
| 74 | + |
| 75 | + This will enable legacy support for OpenSSL. |
| 76 | + |
| 77 | +4. Start the Frontend Development Server: |
| 78 | + |
| 79 | + ```bash |
| 80 | + npm start |
| 81 | + ``` |
| 82 | + |
| 83 | + The frontend will be available at [http://localhost:4200](http://localhost:4200). |
| 84 | + |
| 85 | +## Contributing |
| 86 | +Check out our [CONTRIBUTING](https://github.com/microcks/hub.microcks.io/blob/master/CONTRIBUTING.md) guide for details. All the best! 🚀 |
0 commit comments