Skip to content

Commit 47fa9a7

Browse files
created installation.md (#306)
Signed-off-by: krishi-agrawal <krishi.agrawal26@gmail.com>
1 parent a96d9f4 commit 47fa9a7

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

INSTALLATION.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Setting Up the Microcks.io Repository
2+
3+
Follow these steps to set up the Microcks.io repository locally.
4+
5+
## 1. Fork the Repository
6+
First, fork the [Microcks.io repository](https://github.com/microcks/microcks.io) to your GitHub account.
7+
8+
## 2. Clone the Repository
9+
Next, clone the forked repository to your local machine:
10+
11+
sh
12+
git clone https://github.com/YOUR-USERNAME/microcks.io.git
13+
14+
15+
Replace YOUR-USERNAME with your GitHub username.
16+
17+
## 3. Navigate to the Project Directory
18+
sh
19+
cd microcks.io
20+
21+
22+
## 4. Install Hugo
23+
Microcks.io is powered by [Hugo](https://gohugo.io/). You need to install it to run the website locally.
24+
25+
Follow the official installation guide for your operating system: [Hugo Installation](https://gohugo.io/installation/).
26+
27+
## 5. Start the Local Server
28+
Run the following command to start the local development server:
29+
30+
sh
31+
hugo server
32+
33+
34+
This will download the necessary Hugo modules and start a local server.
35+
36+
## 6. View the Website
37+
Once the server is running, open your browser and go to:
38+
39+
40+
http://localhost:1313
41+
42+
43+
Now you can see the Microcks.io website running locally!
44+
45+
---
46+
47+
## Contributing
48+
Check out our [CONTRIBUTING](https://github.com/microcks/microcks.io/blob/master/CONTRIBUTING.md) guide for details. Happy coding! 🚀

0 commit comments

Comments
 (0)