Unraid Connect

Monorepo for Unraid Connect and the Unraid API.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Built With

• 
• 
• 
• 

(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)
• Just
• An Unraid 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

   # 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.

   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

   cd api
   npm run container:start

4. This should bring you inside the API container. There, run the following command to start the server:

   npm run dev

5. In another terminal, open the project and navigate to the web directory. Then, run the dev server:

   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

(back to top)

Contact

@UnraidOfficial - support@unraid.net.com

Project Link: https://github.com/unraid/api

(back to top)

Acknowledgments

(back to top)