Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes 286: Missing INSTALLATION.md #294

Closed
wants to merge 17 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions INSTALLATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Setting Up the Microcks.io Repository

Follow these steps to set up the Microcks.io repository locally.

## 1. Fork the Repository
First, fork the [Microcks.io repository](https://github.com/microcks/microcks.io) to your GitHub account.

## 2. Clone the Repository
Next, clone the forked repository to your local machine:

```sh
git clone https://github.com/YOUR-USERNAME/microcks.io.git
```

Replace `YOUR-USERNAME` with your GitHub username.

## 3. Navigate to the Project Directory
```sh
cd microcks.io
```

## 4. Install Hugo
Microcks.io is powered by [Hugo](https://gohugo.io/). You need to install it to run the website locally.

Follow the official installation guide for your operating system: [Hugo Installation](https://gohugo.io/installation/).

## 5. Start the Local Server
Run the following command to start the local development server:

```sh
hugo server
```

This will download the necessary Hugo modules and start a local server.

## 6. View the Website
Once the server is running, open your browser and go to:

```
http://localhost:1313
```

Now you can see the Microcks.io website running locally!

---

## Contributing
Check out our [CONTRIBUTING](https://github.com/microcks/microcks.io/blob/master/CONTRIBUTING.md) guide for details. Happy coding! 🚀