diff --git a/readme.md b/readme.md
index dce8b122f..953a333ab 100644
--- a/readme.md
+++ b/readme.md
@@ -17,8 +17,6 @@
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
-
-
@@ -42,8 +40,6 @@
-
-
Table of Contents
@@ -70,7 +66,6 @@
-
## About The Project
@@ -87,8 +82,6 @@
(back to top)
-
-
## Getting Started
@@ -99,11 +92,11 @@ communicating with each other.
Make sure the following software is installed before proceeding.
-- Bash
-- Docker (for macOS folks, Orbstack works too)
-- [Node.js (v20)][Node-url]
-- [Just](https://github.com/casey/just)
-- An [Unraid][Unraid-url] server for development
+* Bash
+* Docker (for macOS folks, Orbstack works too)
+* [Node.js (v20)][Node-url]
+* [Just](https://github.com/casey/just)
+* An [Unraid][Unraid-url] server for development
Next, create an SSH key if you haven't already.
Once you have your key pair, add your public SSH key to your Unraid server:
@@ -116,26 +109,35 @@ Once you have your key pair, add your public SSH key to your Unraid server:
### Installation
1. Clone and enter the repo
+
```sh
# Optionally, give the cloned folder a more specific name
gh repo clone unraid/api api-monorepo
cd api-monorepo
```
+
2. Run the monorepo setup command.
+
```sh
just setup
```
+
This will run installation scripts, container builds, and some git scripts to reduce noise (i.e. personal editor customizations, etc).
3. Run the API container
+
```sh
cd api
npm run container:start
```
+
4. This should bring you inside the API container. There, run the following command to start the server:
+
```js
npm run dev
```
+
5. In another terminal, open the project and navigate to the web directory. Then, run the dev server:
+
```sh
cd web
npm install # just in case
@@ -144,7 +146,6 @@ Once you have your key pair, add your public SSH key to your Unraid server:
(back to top)
-
## Usage
@@ -154,8 +155,6 @@ _For more examples, please refer to the [Documentation](https://docs.unraid.net/
(back to top)
-
-
-
-
-
+
-
## Contact
-[@UnraidOfficial](https://twitter.com/UnraidOfficial) - support@unraid.net.com
+[@UnraidOfficial](https://twitter.com/UnraidOfficial) -
Project Link: [https://github.com/unraid/api](https://github.com/unraid/api)
(back to top)
-
## Acknowledgments
@@ -217,8 +233,6 @@ Project Link: [https://github.com/unraid/api](https://github.com/unraid/api)
(back to top)
-
-
[contributors-shield]: https://img.shields.io/github/contributors/unraid/api.svg?style=for-the-badge
@@ -233,7 +247,6 @@ Project Link: [https://github.com/unraid/api](https://github.com/unraid/api)
[license-url]: https://github.com/unraid/api/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/company/unraid
-[product-screenshot]: images/screenshot.png
[Nuxt.js]: https://img.shields.io/badge/Nuxt-002E3B?style=for-the-badge&logo=nuxtdotjs&logoColor=#00DC82
[Node.js]: https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white
[PHP]: https://img.shields.io/badge/php-%23777BB4.svg?style=for-the-badge&logo=php&logoColor=white
@@ -241,4 +254,4 @@ Project Link: [https://github.com/unraid/api](https://github.com/unraid/api)
[Unraid-url]: https://unraid.net
[Nuxt-url]: https://nuxt.com/
[Node-url]: https://nodejs.org/
-[PHP-url]: https://php.net/
\ No newline at end of file
+[PHP-url]: https://php.net/