Merge pull request #50 from walkxcode/devel

✨Multiple QoL updates!

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,52 @@
+name: 🐛 Bug Report
+description: Report something that's broken, or not working like intented!
+title: '[🐛 Bug] <title>'
+labels: ['🐛 Bug']
+assignees:
+  - ajnart
+body:
+  - type: dropdown
+    id: environment
+    attributes:
+      label: Environment
+      description: How have you deployed Homarr?
+      options:
+        - Docker
+        - NodeJS
+        - Cloud Service (Static)
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: What version of Homarr are you running?
+      placeholder: 0.1.0
+    validations:
+      required: false
+  - type: textarea
+    id: repro
+    attributes:
+      label: Describe the problem
+      description: Please describe the problem exactly, how to reproduce it, actual results, and expected results.
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Additional info
+      description: Logs? Screenshots? More info?
+    validations:
+      required: false
+  - type: checkboxes
+    id: idiot-check
+    attributes:
+      label: Please tick the boxes
+      description: Before submitting, please ensure that
+      options:
+        - label: You've read the [docs](https://github.com/ajnart/homarr#readme)
+          required: true
+        - label: You've checked for [duplicate issues](https://github.com/ajnart/homarr/issues)
+          required: true
+        - label: You've tried to debug yourself
+          required: true

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,25 @@
+name: ✨ Feature Request
+description: Request a feature to help improve Homarr!
+title: '[✨ Feature] <title>'
+labels: ['✨ Feature']
+assignees:
+  - ajnart
+body:
+  - type: textarea
+    id: feature
+    attributes:
+      label: Describe the feature you would like to see
+      placeholder: An outline of the feature you would like to see implemented, include as much detail as possible!
+    validations:
+      required: true
+  - type: dropdown
+    id: priority
+    attributes:
+      label: Priority
+      description: How urgent is the development of this feature?
+      options:
+        - Low (Nice-to-have)
+        - Medium (Would be very useful)
+        - High (App breaking feature)
+    validations:
+      required: true

README.md

@@ -1,33 +1,86 @@
-# MyHomePage, a home page for your home server
+<p align = "center">
-### Do not hesitate to star ⭐ this repo if you like the project ! ![](https://img.shields.io/github/stars/ajnart/myhomepage?label=%E2%AD%90&style=for-the-badge?branch=master&kill_cache=1")
+  <h3 align = "center"> Homarr <h3>
-### Join the discord ! : https://discord.gg/C2WTXkzkwK 
-## What is MyHomePage ?
 
-HomePage is a web page for your home server, it provides a user friendly interface to access docker containers or other services.
+  <p align = "center">
+    A homepage for <i>your</i> server.
+  <br/>
+  <a href = "https://github.com/ajnart/homarr/deployments/activity_log?environment=Production" > <strong> Demo ↗️ </strong> </a> • <a href = "#install" > <strong> Install ➡️ </strong> </a>
+  <br />
+  <br />
+  <a href = "https://discord.gg/aCsmEV5RgA" > <img src="https://discordapp.com/api/guilds/972958686051962910/widget.png?style=shield" > </a>
+</p>
+</p>
 
-## Install
+# 📃 Table of Contents
-### Docker installation
+- [📃 Table of Contents](#-table-of-contents)
-Required : Docker
+- [🚀 Getting Started](#-getting-started)
-#### Standard docker install
+  - [ℹ️ About](#ℹ️-about)
-To install the MyHomePage docker image simply execute ``docker pull ghcr.io/ajnart/mhp``  
+  - [⚡ Installation](#-installation)
-To run the docker file ``docker run --name my-home-page -p 7575:80 -d ghcr.io/ajnart/mhp``  
+    - [Deploying from Docker Image 🐳](#deploying-from-docker-image-)
+    - [Building from Source 🛠️](#building-from-source-️)
+- [💖 Contributing](#-contributing)
 
-*Note: Currently the port used is 80 (Nginx default port) It will change to be 7575 by default*  
+<!-- Getting Started -->
-#### Docker compose
+# 🚀 Getting Started
-Here's a docker compose example on how to integrate MHP into your container stack
+
-```docker
+## ℹ️ About
+
+Homarr is a simple and lightweight homepage for your server, that helps you easily access all of your services in one place.
+    
+**[⤴️ Back to Top](#-table-of-contents)**
+
+## ⚡ Installation
+
+### Deploying from Docker Image 🐳
+> Supported architectures: x86-64, ARM, ARM64
+
+_Requirements_:
+- [Docker](https://docs.docker.com/get-docker/)
+
+**Standard Docker Install**
+```sh
+docker run --name homarr -p 7575:80 -d ghcr.io/ajnart/mhp
+```
+
+**Docker Compose**
+```yml
+---
+version: '3'
+#--------------------------------------------------------------------------------------------#
+#                               Homarr -  A homepage for your server.                        #
+#--------------------------------------------------------------------------------------------#
 services:
   mhp:
+    container_name: homarr
     image: ghcr.io/ajnart/mhp
+    restart: unless-stopped
     ports:
       - '7575:80'
-    restart: always
 ```
-### Local installation
+
-Required: Node (LTS)
+### Building from Source 🛠️
-#### Install using node
+
-To install MyHomePage locally:
+_Requirements_:
-- Clone the source code or download it.
+- [Git](https://git-scm.com/downloads)
-- Execute ``npm install`` or ``yarn install`` *(prefered)* to install the dependencies
+- [NodeJS](https://nodejs.org/en/) _(Latest or LTS)_
-- Execute ``yarn export`` to build the source code into the final HTML pages in the ``./out`` folder
+- [Yarn](https://yarnpkg.com/)
-- Run a web server to serve the content of the ``./out`` folder. Example: ``python -m http.server 7575 --directory out``
+- 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)**
+
+# 💖 Contributing
+You can contribute by [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)!
+
+All contributions are highly appreciated.
+    
+**[⤴️ Back to Top](#-table-of-contents)**

components/AppShelf/AddAppShelfItem.tsx

@@ -73,11 +73,7 @@ export default function AddItemShelfItem(props: any) {
 }
 
 function MatchIcon(name: string, form: any) {
-  // TODO: In order to avoid all the requests, we could fetch
+  fetch(`https://cdn.jsdelivr.net/gh/walkxhub/dashboard-icons/png/${name.replace(/\s+/g, '-').toLowerCase()}.png`)
-  // https://data.jsdelivr.com/v1/package/gh/IceWhaleTech/AppIcon@main
-  // and then iterate over the files -> files -> name and then remove the extension (.png)
-  // Compare it to the input and then fetch the icon
-  fetch(`https://cdn.jsdelivr.net/gh/IceWhaleTech/AppIcon@main/all/${name.toLowerCase()}.png`)
     .then((res) => {
       if (res.status === 200) {
         form.setFieldValue('icon', res.url);

components/layout/Footer.tsx

@@ -60,7 +60,7 @@ export function Footer({ links }: FooterCenteredProps) {
     >
       <Group className={classes.links}>{items}</Group>
       <Group spacing="xs" position="right" noWrap>
-        <ActionIcon<'a'> component="a" href="https://github.com/ajnart/myhomepage" size="lg">
+        <ActionIcon<'a'> component="a" href="https://github.com/ajnart/homarr" size="lg">
           <BrandGithub size={18} />
         </ActionIcon>
       </Group>

components/layout/Logo.tsx

@@ -2,14 +2,9 @@ import { Text } from '@mantine/core';
 import * as React from 'react';
 
 export function Logo({ style }: any) {
-  return (
+	return (
-    <Text
+		<Text sx={style} weight="bold" variant="gradient" gradient={{ from: 'red', to: 'orange', deg: 145 }}>
-      sx={style}
+			Homarr
-      weight="bold"
+		</Text>
-      variant="gradient"
+	);
-      gradient={{ from: 'red', to: 'orange', deg: 145 }}
-    >
-      MyHomePage
-    </Text>
-  );
 }

package.json

@@ -1,12 +1,12 @@
 {
-  "name": "homarr",
+	"name": "homarr",
-  "version": "0.1.3",
+	"version": "0.1.3",
-  "private": "false",
+	"private": "false",
-  "description": "Customizable browser's home page to interact with your homeserver's Docker containers (i.e. Sonarr/Radarr)",
+	"description": "Homarr -  A homepage for your server.",
-  "repository": {
+	"repository": {
-    "type": "git",
+		"type": "git",
-    "url": "https://github.com/ajnart/myhomepage"
+		"url": "https://github.com/ajnart/homarr"
-  },
+	},
   "scripts": {
     "dev": "next dev",
     "build": "next build",

pages/_app.tsx

@@ -22,7 +22,7 @@ export default function App(props: AppProps & { colorScheme: ColorScheme }) {
   return (
     <>
       <Head>
-        <title>MyHomePage - Your new browser homepage!</title>
+        <title>Homarr -  A homepage for your server!</title>
         <meta name="viewport" content="minimum-scale=1, initial-scale=1, width=device-width" />
         <link rel="shortcut icon" href="/favicon.svg" />
       </Head>