Update README.md

This commit is contained in:
Aj - Thomas
2022-05-13 10:37:36 +02:00
committed by GitHub
parent 7618bc4e1f
commit 62f62db17c

View File

@@ -4,10 +4,13 @@
<p align = "center"> <p align = "center">
A homepage for <i>your</i> server. A homepage for <i>your</i> server.
<br/> <br/>
<a href = "https://github.com/ajnart/homarr/deployments/activity_log?environment=Production" > <strong> Demo ↗️ </strong> </a> • <a href = "#install" > <strong> Install ➡️ </strong> </a> <a href = "https://github.com/ajnart/homarr/deployments/activity_log?environment=Production" > <strong> Demo ↗️ </strong> </a> • <a href = "#-installation" > <strong> Install ➡️ </strong> </a>
<br /> <br />
<br /> <br />
<a href = "https://discord.gg/aCsmEV5RgA" > <img src="https://discordapp.com/api/guilds/972958686051962910/widget.png?style=shield" > </a> <p>
Join the discord !
<a href = "https://discord.gg/aCsmEV5RgA" > <img src="https://discordapp.com/api/guilds/972958686051962910/widget.png?style=shield" > </a>
</p>
</p> </p>
</p> </p>
@@ -64,19 +67,14 @@ _Requirements_:
- [Git](https://git-scm.com/downloads) - [Git](https://git-scm.com/downloads)
- [NodeJS](https://nodejs.org/en/) _(Latest or LTS)_ - [NodeJS](https://nodejs.org/en/) _(Latest or LTS)_
- [Yarn](https://yarnpkg.com/) - [Yarn](https://yarnpkg.com/)
- Some web server
**Installing** **Installing**
- Clone the GitHub repo: `git clone https://github.com/ajnart/homarr.git` & `cd homarr` - Clone the GitHub repo: `git clone https://github.com/ajnart/homarr.git` & `cd homarr`
- Install all dependencies: `yarn install` - Install all dependencies: `yarn install`
- Build the source: `yarn export` - Build the source: `yarn build`
- Start a web server (Any web server will work): - Start the NextJS web server: ``yarn start``
- _Examples:_ - 📝Note: If you want to update the code in real time, launch with ``yarn dev``
- NodeJS serve: `npm i -g serve` or `yarn global add serve` & `serve ./out`
- python http.server: `python -m http.server 7474 --directory out`
**[⤴️ Back to Top](#-table-of-contents)**
# 💖 Contributing # 💖 Contributing
You can contribute by [Starting a discussion](https://github.com/ajnart/homarr/discussions), [Submitting Bugs](https://github.com/ajnart/homarr/issues/new), [Requesting Features](https://github.com/ajnart/homarr/issues/new), or [Making a pull request](https://github.com/ajnart/homarr/compare)! You can contribute by [Starting a discussion](https://github.com/ajnart/homarr/discussions), [Submitting Bugs](https://github.com/ajnart/homarr/issues/new), [Requesting Features](https://github.com/ajnart/homarr/issues/new), or [Making a pull request](https://github.com/ajnart/homarr/compare)!