mirror of
				https://github.com/ajnart/homarr.git
				synced 2025-10-31 10:36:02 +01:00 
			
		
		
		
	feat: Multiple QoL updates
This commit is contained in:
		
							
								
								
									
										52
									
								
								.github/ISSUE_TEMPLATE/bug.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										52
									
								
								.github/ISSUE_TEMPLATE/bug.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -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 | ||||||
							
								
								
									
										25
									
								
								.github/ISSUE_TEMPLATE/feature-request.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										25
									
								
								.github/ISSUE_TEMPLATE/feature-request.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -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 | ||||||
| @@ -1,33 +0,0 @@ | |||||||
| # MyHomePage, a home page for your home server |  | ||||||
| ### Do not hesitate to star ⭐ this repo if you like the project !  |  | ||||||
| ### 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. |  | ||||||
|  |  | ||||||
| ## Install |  | ||||||
| ### Docker installation |  | ||||||
| Required : Docker |  | ||||||
| #### Standard docker install |  | ||||||
| To install the MyHomePage docker image simply execute ``docker pull ghcr.io/ajnart/mhp``   |  | ||||||
| To run the docker file ``docker run --name my-home-page -p 7575:80 -d ghcr.io/ajnart/mhp``   |  | ||||||
|  |  | ||||||
| *Note: Currently the port used is 80 (Nginx default port) It will change to be 7575 by default*   |  | ||||||
| #### Docker compose |  | ||||||
| Here's a docker compose example on how to integrate MHP into your container stack |  | ||||||
| ```docker |  | ||||||
| services: |  | ||||||
|   mhp: |  | ||||||
|     image: ghcr.io/ajnart/mhp |  | ||||||
|     ports: |  | ||||||
|       - '7575:80' |  | ||||||
|     restart: always |  | ||||||
| ``` |  | ||||||
| ### Local installation |  | ||||||
| Required: Node (LTS) |  | ||||||
| #### Install using node |  | ||||||
| To install MyHomePage locally: |  | ||||||
| - Clone the source code or download it. |  | ||||||
| - Execute ``npm install`` or ``yarn install`` *(prefered)* to install the dependencies |  | ||||||
| - Execute ``yarn export`` to build the source code into the final HTML pages in the ``./out`` folder |  | ||||||
| - Run a web server to serve the content of the ``./out`` folder. Example: ``python -m http.server 7575 --directory out`` |  | ||||||
| @@ -5,6 +5,9 @@ | |||||||
|     A homepage for <i>your</i> server. |     A homepage for <i>your</i> server. | ||||||
|   <br/> |   <br/> | ||||||
|   <a href = "https://github.com/ajnart/homarr/deployments/activity_log?environment=Production" > <strong> Demo ↗️ </strong> </a> • <a href = "#install" > <strong> Install ➡️ </strong> </a> |   <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> | ||||||
| </p> | </p> | ||||||
|  |  | ||||||
| @@ -15,6 +18,7 @@ | |||||||
|   - [⚡ Installation](#-installation) |   - [⚡ Installation](#-installation) | ||||||
|     - [Deploying from Docker Image 🐳](#deploying-from-docker-image-) |     - [Deploying from Docker Image 🐳](#deploying-from-docker-image-) | ||||||
|     - [Building from Source 🛠️](#building-from-source-️) |     - [Building from Source 🛠️](#building-from-source-️) | ||||||
|  | - [💖 Contributing](#-contributing) | ||||||
|  |  | ||||||
| <!-- Getting Started --> | <!-- Getting Started --> | ||||||
| # 🚀 Getting Started | # 🚀 Getting Started | ||||||
| @@ -62,10 +66,12 @@ _Requirements_: | |||||||
|  |  | ||||||
| **Installing** | **Installing** | ||||||
|  |  | ||||||
| - Clone the GitHub repo: `git clone https://github.com/ajnart/homarr.git` & `cd myhomepage` | - Clone the GitHub repo: `git clone https://github.com/ajnart/homarr.git` & `cd homarr` | ||||||
| - Install all dependencies: `yarn install` | - Install all dependencies: `yarn install` | ||||||
| - Build the source: `yarn export` | - Build the source: `yarn export` | ||||||
| - Start a web server (Any web server will work): | - Start a web server (Any web server will work): | ||||||
|   - _Examples:_ |   - _Examples:_ | ||||||
|     - NodeJS serve: `npm i -g serve` or `yarn global add serve` & `serve ./out` |     - NodeJS serve: `npm i -g serve` or `yarn global add serve` & `serve ./out` | ||||||
|     - python http.server: `python -m http.server 7474 --directory out` |     - python http.server: `python -m http.server 7474 --directory out` | ||||||
|  |  | ||||||
|  | # 💖 Contributing | ||||||
|   | |||||||
| @@ -82,11 +82,7 @@ function MatchIcon( | |||||||
|     apiKey: any; |     apiKey: 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/walkxhub/dashboard-icons/png/${name.toLowerCase()}.png`) |  | ||||||
|     .then((res) => { |     .then((res) => { | ||||||
|       if (res.status === 200) { |       if (res.status === 200) { | ||||||
|         form.setFieldValue('icon', res.url); |         form.setFieldValue('icon', res.url); | ||||||
|   | |||||||
| @@ -60,7 +60,7 @@ export function Footer({ links }: FooterCenteredProps) { | |||||||
|     > |     > | ||||||
|       <Group className={classes.links}>{items}</Group> |       <Group className={classes.links}>{items}</Group> | ||||||
|       <Group spacing="xs" position="right" noWrap> |       <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} /> |           <BrandGithub size={18} /> | ||||||
|         </ActionIcon> |         </ActionIcon> | ||||||
|       </Group> |       </Group> | ||||||
|   | |||||||
| @@ -3,13 +3,8 @@ import * as React from 'react'; | |||||||
|  |  | ||||||
| export function Logo({ style }: any) { | 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" |  | ||||||
|       variant="gradient" |  | ||||||
|       gradient={{ from: 'red', to: 'orange', deg: 145 }} |  | ||||||
|     > |  | ||||||
|       MyHomePage |  | ||||||
| 		</Text> | 		</Text> | ||||||
| 	); | 	); | ||||||
| } | } | ||||||
|   | |||||||
| @@ -2,10 +2,10 @@ | |||||||
| 	"name": "homarr", | 	"name": "homarr", | ||||||
| 	"version": "0.0.1", | 	"version": "0.0.1", | ||||||
| 	"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": { | 	"scripts": { | ||||||
| 		"dev": "next dev", | 		"dev": "next dev", | ||||||
|   | |||||||
| @@ -22,7 +22,7 @@ export default function App(props: AppProps & { colorScheme: ColorScheme }) { | |||||||
|   return ( |   return ( | ||||||
|     <> |     <> | ||||||
|       <Head> |       <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" /> |         <meta name="viewport" content="minimum-scale=1, initial-scale=1, width=device-width" /> | ||||||
|         <link rel="shortcut icon" href="/favicon.svg" /> |         <link rel="shortcut icon" href="/favicon.svg" /> | ||||||
|       </Head> |       </Head> | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user