Skip to content

INSTALLATION.NEXT.md

Latest commit

 

History

History
84 lines (55 loc) · 1.82 KB

INSTALLATION.NEXT.md

File metadata and controls

84 lines (55 loc) · 1.82 KB

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 (v18.x or above) (Preferably, use Volta)
  • 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.

  2. Clone the repository to your local machine:

    git clone https://github.com/YOUR_USERNAME/hub.microcks.io.git
cd hub.microcks.io

Backend Setup

  1. Navigate to the Backend Directory:

    cd server

  2. Install Backend Dependencies:

    npm install

  3. Start the Backend Server:

    npm run start

    The backend server will start on 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.

React Setup

  1. Navigate to the root Directory:

    cd ..

  2. Install Frontend Dependencies:

    npm install

  3. Navigate to the react Directory:

    cd react

  4. Start the Frontend Development Server:

    npm run dev

    The frontend will be available at http://localhost:4200.

Contributing

Check out our CONTRIBUTING guide for details. All the best! 🚀