docs: Update README

README.md

@@ -6,18 +6,21 @@
 ![Version](https://ghcr-badge.egpl.dev/aleksilassila/reiverr/latest_tag?color=%2344cc11&ignore=latest&label=version&trim=)
 ![Size](https://ghcr-badge.egpl.dev/aleksilassila/reiverr/size?color=%2344cc11&tag=latest&label=image+size&trim=)
 
-Reiverr is a project that aims to create a single UI for interacting with TMDB, Jellyfin, Radarr and Sonarr, as well as be an alternative to Overseerr.
+Reiverr is a project that aims to create a single UI for interacting with TMDB, Jellyfin, Radarr and Sonarr, as well as
+be an alternative to Overseerr.
 
-This project is still in alpha, and many features are still missing / being tested and changed. Contributions are welcome! See [contributing](#Contributing) for more information.
+This project is still in early stages, and many features are still missing / being tested and changed.
+Contributions are welcome! See [contributing](#Contributing) for more information.
 
-![Demo Videi](images/reiverr-demo.gif)
+![Demo Video](images/reiverr-demo.gif)
 
-# List of major featuers
+# List of major features
 
 TMDB Discovery:
 
 - Discover trending movies and TV shows
-- Browse movies and TV shows by genre or network
+- Get personalized recommendations based on your ratings
+- ~~Browse movies and TV shows by genre or network~~
 - View details about movies and TV shows, such as cast, crew, ratings & a trailer.
 - Movie & TV show search
 
@@ -26,16 +29,14 @@ Local Library & Playback
 - Stream Movies & TV shows (from Jellyfin library)
 - Create requests for movies & TV shows in Radarr & Sonarr
 - Manage local library files
-- View Radarr & Sonarr stats (disk space, items, etc.)
+- ~~View Radarr & Sonarr stats (disk space, items, etc.)~~
-
+  
 For a list of planned features & known bugs, see [Reiverr Taskboard](https://github.com/users/aleksilassila/projects/5).
 
 # Installation
 
 The easiest and the recommended way to install Reiverr is via Docker. Make sure to update the api keys and base URLs to match your setup.
 
-Radarr & Sonarr API keys can be found under Settings > General in their respective web UIs. Jellyfin API key is located under Administration > Dashboard > Advanced > API Keys in the Jellyfin Web UI.
-
 ### Docker CLI
 
 ```sh
@@ -65,26 +66,43 @@ services:
     restart: unless-stopped
 ```
 
-### Manual Instructions
+### Building from Source
 
-1. Requirements:
+1. Requirements(ish):
-   - Node v18.14.0 or high
+   - Node v18.14.0 or higher
-   - NPM v9.3.1 or high
+   - NPM v9.3.1 or higher
-1. Clone from **master** or download the [latest source](https://github.com/aleksilassila/reiverr/releases)
+2. Clone from **master** or download the [latest source](https://github.com/aleksilassila/reiverr/releases)
-1. Build the app:
+3. Build the app:\
-   ```sh
+   `npm install`\
-   npm ci --ignore-scripts
+   `npm install --prefix backend`\
-   npm run build
+   `npm run build`
-   npm ci --ignore-scripts --omit=dev # optional
+4. Start the app:\
-   ```
+   `node backend/dist/main`
-1. Start the app:
-   ```sh
-   npm run deploy
-   ```
 
-### Reiverr will be accessible via port 9494 by default.
+#### Reiverr will be accessible via port 9494 by default.
 
-If you have any questions or run into issues or bugs, you can start a [discussion](https://github.com/aleksilassila/reiverr/discussions), open an [issue](https://github.com/aleksilassila/reiverr/issues) or check out the [Discord channel](https://discord.gg/enypPQh6pz).
+### Tizen / Samsung Smart TVs
+
+To be able to use Reiverr on TVs, you'll still need to host the backend server on a separate device.
+See the above methods for instructions on how to set up the backend / web app.
+
+There are plans to attempt getting the app to the official store. In the meantime, you have to manually build and install
+the app using Tizen Studio or the CLI, following roughly these steps:
+
+1. Follow the manual installation steps above to install the dependencies (npm install)
+2. Download either Tizen Studio or the CLI tools from the [official website](https://developer.tizen.org/development/tizen-studio/download)
+3. [Connect Tizen Studio to your TV](https://developer.samsung.com/smarttv/develop/getting-started/using-sdk/tv-device.html)
+4. Use the following command to build and install the app on your TV:\
+\
+`npm run build:tizen;C:\tizen-studio\tools\ide\bin\tizen.bat build-web -- tizen;C:\tizen-studio\tools\ide\bin\tizen.bat package -t wgt -o .\tizen -- .\tizen\.buildResult\;C:\tizen-studio\tools\ide\bin\tizen.bat install -n .\tizen\Reiverr.wgt -t QE55Q64TAUXXC`.\
+\
+You may need to replace the paths for Tizen Studio tools according to your installation location, as well as the device identifier, which was in my case the tv model number.\
+\
+Alternatively, you can open the project in Tizen Studio and install the project on a device from there. For more instructions on run a project on a device, see [here](https://docs.tizen.org/application/web/get-started/tv/first-samsung-tv-app/#run-on-a-target-device).
+
+If you have any questions or run into issues or bugs, you can start a [discussion](https://github.com/aleksilassila/reiverr/discussions),
+open an [issue](https://github.com/aleksilassila/reiverr/issues)
+or check out the [Discord channel](https://discord.gg/enypPQh6pz).
 
 ## Other Platforms
 
@@ -92,19 +110,31 @@ The roadmap includes plans to support the following platforms in the future:
 
 - Windows Desktop App
 - MacOS Desktop App
-- Android TV / TizenOS
+- Android TV / WebOS
+
+# Post Installation
+
+To create the first user account, you can log in with any credentials and an admin account will be created.
+To get most out of Reiverr, it is recommended to connect to TMDB, Jellyfin, Radarr and Sonarr.
+
+> Hint: Radarr & Sonarr API keys can be found under Settings > General in their respective web UIs. Jellyfin API key is located under Administration > Dashboard > Advanced > API Keys in the Jellyfin Web UI.
+
 
 # Contributing
 
-Unlike the most Servarr projects, this one is built with Svelte and SvelteKit. If you haven't used Svelte before, don't worry, this was my first Svelte project too. I'd recommend reading the official [Svelte tutorial](https://learn.svelte.dev/tutorial/welcome-to-svelte) to get started.
+Unlike the most Servarr projects, this one is built with Svelte and NestJS. If you haven't used Svelte before,
+don't worry, this was my first Svelte project too. I'd recommend reading the official [Svelte tutorial](https://learn.svelte.dev/tutorial/welcome-to-svelte) to
+get started.
 
-To see a list of missing features & known bugs that you can help with, see [Reiverr Taskboard](https://github.com/users/aleksilassila/projects/5). Feel free to also create your own issues for bug reports or feature requests, as well as discussions for general questions.
+To see a list of missing features & known bugs that you can help with,
+see [Reiverr Taskboard](https://github.com/users/aleksilassila/projects/7). Feel free to also create your own
+issues for bug reports or feature requests, as well as discussions for general questions.
 
 Before you contribute:
 
 - If you are taking on an existing bug or feature ticket, please comment on the issue or mark yourself as an assignee to avoid multiple people working on the same thing.
 - If the ticket is vague or missing information, please ask for clarification in the comments.
-- UI style must match the rest of the project and it is a good idea to discuss the design beforehand, especially for larger design choices (issues labelled with "design").
+- UI style should match the rest of the project, and it is a good idea to discuss the design beforehand, especially for larger design choices (issues labelled with "design").
 - [Conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) are encouraged.
 - When creating a pull request, please make sure to target the `dev` branch and mark the PR as a draft if it is a work in progress.
 
@@ -116,12 +146,11 @@ To get started with development:
 
 1. Clone the repository
 2. Check out the `dev` branch
-3. Run `npm install`
+3. Install dependencies\
-4. Run `npm run dev`
+   `npm install`\
-
+   `npm install --prefix backend`
-Alternatively, you can run `docker-compose up`.
+4. To start the frontend: `npm run dev` or `npx vite --host` if you want to expose the server
-
+5. To start the backend: `npm run --prefix backend start:dev`
-For Webstorm users: I'd recommend using VS Code as it has way better Svelte Typescript support.
 
 Useful resources:
 

package.json

@@ -8,7 +8,7 @@
 	"type": "module",
 	"scripts": {
 		"dev": "vite",
-		"build": "vite build",
+		"build": "npm run --prefix backend build && vite build --outDir backend/dist/dist",
 		"build:tizen": "set VITE_PLATFORM=tv&& vite build --outDir tizen/dist",
 		"preview": "vite preview",
 		"preview:tizen": "set VITE_PLATFORM=tv&& vite build --outDir tizen/dist && vite preview --outDir tizen/dist",

src/App.svelte

@@ -43,7 +43,10 @@
 		if ($localSettings.checkForUpdates)
 			fetchLatestVersion().then((latestVersion) => {
 				// @ts-ignore
-				if (latestVersion !== `v${VERSION}` && latestVersion !== $localSettings.skippedVersion) {
+				if (
+					latestVersion !== `v${REIVERR_VERSION}` &&
+					latestVersion !== $localSettings.skippedVersion
+				) {
 					createModal(UpdateDialog, { version: latestVersion });
 				}
 			});

src/lib/components/UpdateChecker.svelte

@@ -15,7 +15,7 @@
 </script>
 
 {#await fetchLatestVersion() then latestVersion}
-	{#if latestVersion !== `v${VERSION}` && latestVersion !== $skippedVersion && visible}
+	{#if latestVersion !== `v${REIVERR_VERSION}` && latestVersion !== $skippedVersion && visible}
 		<div
 			class="fixed inset-x-0 bottom-0 p-3 flex items-center justify-center z-20 bg-stone-800 text-sm"
 		>

vite.config.ts

@@ -24,7 +24,7 @@ export default defineConfig({
 	],
 	optimizeDeps: { exclude: ['svelte-navigator'] },
 	define: {
-		VERSION: `"${pkg.version}"`
+		REIVERR_VERSION: `"${pkg.version}"`
 	}
 
 	// base: '/dist',