[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
Table of Contents
-
About The Project
-
Getting Started
- Usage
- Roadmap
- Contributing
- License
- Contact
- Acknowledgments
## About The Project
### Built With
* [![Unraid][Unraid]][Unraid-url]
* [![Node.js][Node.js]][Node-url]
* [![Nuxt][Nuxt.js]][Nuxt-url]
* [![PHP][PHP]][PHP-url]
(back to top)
## Getting Started
This section will guide you through the steps necessary to get the monorepo projects running and
communicating with each other.
### Prerequisites
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
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:
1. Log in to your Unraid development server.
2. Use the navigation menu to go to 'Users'.
3. Click on the user you logged in with (e.g. `root`)
4. Paste your SSH public key into 'SSH authorized keys' and click 'Save'.
### 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
npm run dev
```
(back to top)
## Usage
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
_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
Project Link: [https://github.com/unraid/api](https://github.com/unraid/api)
(back to top)
## Acknowledgments
* []()
* []()
* []()
(back to top)
[contributors-shield]: https://img.shields.io/github/contributors/unraid/api.svg?style=for-the-badge
[contributors-url]: https://github.com/unraid/api/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/unraid/api.svg?style=for-the-badge
[forks-url]: https://github.com/unraid/api/network/members
[stars-shield]: https://img.shields.io/github/stars/unraid/api.svg?style=for-the-badge
[stars-url]: https://github.com/unraid/api/stargazers
[issues-shield]: https://img.shields.io/github/issues/unraid/api.svg?style=for-the-badge
[issues-url]: https://github.com/unraid/api/issues
[license-shield]: https://img.shields.io/github/license/unraid/api.svg?style=for-the-badge
[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
[Unraid]: https://img.shields.io/badge/unraid-%23F15A2C.svg?style=for-the-badge&logo=unraid&logoColor=white
[Unraid-url]: https://unraid.net
[Nuxt-url]: https://nuxt.com/
[Node-url]: https://nodejs.org/
[PHP-url]: https://php.net/ 