From 62f62db17c0298be368be4331e8d319776f8aadf Mon Sep 17 00:00:00 2001 From: Aj - Thomas <49837342+ajnart@users.noreply.github.com> Date: Fri, 13 May 2022 10:37:36 +0200 Subject: [PATCH] Update README.md --- README.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 457f314ae..4403bf122 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,13 @@

A homepage for your server.
- Demo ↗️ Install ➡️ + Demo ↗️ Install ➡️

- +

+ Join the discord ! + +

@@ -64,19 +67,14 @@ _Requirements_: - [Git](https://git-scm.com/downloads) - [NodeJS](https://nodejs.org/en/) _(Latest or LTS)_ - [Yarn](https://yarnpkg.com/) -- Some web server **Installing** - Clone the GitHub repo: `git clone https://github.com/ajnart/homarr.git` & `cd homarr` - Install all dependencies: `yarn install` -- Build the source: `yarn export` -- Start a web server (Any web server will work): - - _Examples:_ - - 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)** +- Build the source: `yarn build` +- Start the NextJS web server: ``yarn start`` +- 📝Note: If you want to update the code in real time, launch with ``yarn dev`` # 💖 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)!