From b94df53267ecb534fce5468d1529aae4972ac82a Mon Sep 17 00:00:00 2001 From: unknown Date: Tue, 3 Aug 2021 10:22:55 +0200 Subject: [PATCH] github directory name changed --- {github => .github}/_apps.png | Bin {github => .github}/_bookmarks.png | Bin {github => .github}/_home.png | Bin {github => .github}/_themes.png | Bin README.md | 43 +++++++++++++++++++++-------- 5 files changed, 31 insertions(+), 12 deletions(-) rename {github => .github}/_apps.png (100%) rename {github => .github}/_bookmarks.png (100%) rename {github => .github}/_home.png (100%) rename {github => .github}/_themes.png (100%) diff --git a/github/_apps.png b/.github/_apps.png similarity index 100% rename from github/_apps.png rename to .github/_apps.png diff --git a/github/_bookmarks.png b/.github/_bookmarks.png similarity index 100% rename from github/_bookmarks.png rename to .github/_bookmarks.png diff --git a/github/_home.png b/.github/_home.png similarity index 100% rename from github/_home.png rename to .github/_home.png diff --git a/github/_themes.png b/.github/_themes.png similarity index 100% rename from github/_themes.png rename to .github/_themes.png diff --git a/README.md b/README.md index 8e27c86..5c1abe2 100644 --- a/README.md +++ b/README.md @@ -5,23 +5,26 @@ [![Node Badge](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white)](https://shields.io/) [![React Badge](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)](https://shields.io/) -![Homescreen screenshot](./github/_home.png) +![Homescreen screenshot](./.github/_home.png) ## Description + Flame is self-hosted startpage for your server. Its design is inspired (heavily) by [SUI](https://github.com/jeroenpardon/sui). Flame is very easy to setup and use. With built-in editors it allows you to setup your very own appliaction hub in no time - no file editing necessary. ## Technology + - Backend - Node.js + Express - Sequelize ORM + SQLite - Frontend - - React + - React - Redux - TypeScript - Deployment - Docker ## Development + ```sh # clone repository git clone https://github.com/pawelmalak/flame @@ -34,13 +37,14 @@ npm run dev-init npm run dev ``` -## Installation +## Installation ### With Docker (recommended) [Docker Hub](https://hub.docker.com/r/pawelmalak/flame) #### Building images + ```sh # build image for amd64 only docker build -t flame . @@ -54,14 +58,16 @@ docker buildx build \ ``` #### Deployment + ```sh # run container docker run -p 5005:5005 -v /path/to/data:/app/data flame ``` #### Docker-Compose + ```yaml -version: "2.1" +version: '2.1' services: flame: image: pawelmalak/flame:latest @@ -74,46 +80,54 @@ services: ``` ### Without Docker + Follow instructions from wiki: [Installation without Docker](https://github.com/pawelmalak/flame/wiki/Installation-without-docker) ## Functionality + - Applications - Create, update, delete and organize applications using GUI - Pin your favourite apps to homescreen -![Homescreen screenshot](./github/_apps.png) +![Homescreen screenshot](./.github/_apps.png) - Bookmarks - Create, update, delete and organize bookmarks and categories using GUI - Pin your favourite categories to homescreen -![Homescreen screenshot](./github/_bookmarks.png) +![Homescreen screenshot](./.github/_bookmarks.png) - Weather + - Get current temperature, cloud coverage and weather status with animated icons - Themes - - Customize your page by choosing from 12 color themes + - Customize your page by choosing from 12 color themes -![Homescreen screenshot](./github/_themes.png) +![Homescreen screenshot](./.github/_themes.png) ## Usage + ### Search bar + #### Searching + To use search bar you need to type your search query with selected prefix. For example, to search for "what is docker" using google search you would type: `/g what is docker`. > You can change where to open search results (same/new tab) in the settings #### Supported search engines + | Name | Prefix | Search URL | -|------------|--------|-------------------------------------| +| ---------- | ------ | ----------------------------------- | | Disroot | /ds | http://search.disroot.org/search?q= | | DuckDuckGo | /d | https://duckduckgo.com/?q= | | Google | /g | https://www.google.com/search?q= | #### Supported services + | Name | Prefix | Search URL | -|--------------------|--------|-----------------------------------------------| +| ------------------ | ------ | --------------------------------------------- | | IMDb | /im | https://www.imdb.com/find?q= | | Reddit | /r | https://www.reddit.com/search?q= | | Spotify | /sp | https://open.spotify.com/search/ | @@ -121,13 +135,16 @@ To use search bar you need to type your search query with selected prefix. For e | Youtube | /yt | https://www.youtube.com/results?search_query= | ### Setting up weather module + 1. Obtain API Key from [Weather API](https://www.weatherapi.com/pricing.aspx). > Free plan allows for 1M calls per month. Flame is making less then 3K API calls per month. 2. Get lat/long for your location. You can get them from [latlong.net](https://www.latlong.net/convert-address-to-lat-long.html). 3. Enter and save data. Weather widget will now update and should be visible on Home page. ### Supported URL formats for applications and bookmarks + #### Rules + - URL starts with `http://` - Format: `http://www.domain.com`, `http://domain.com` - Redirect: `{dest}` @@ -139,11 +156,13 @@ To use search bar you need to type your search query with selected prefix. For e - Redirect: `http://{dest}` ### Custom CSS + > This is an experimental feature. Its behaviour might change in the future. -> -Follow instructions from wiki: [Custom CSS](https://github.com/pawelmalak/flame/wiki/Custom-CSS) +> +> Follow instructions from wiki: [Custom CSS](https://github.com/pawelmalak/flame/wiki/Custom-CSS) ## Support + If you want to support development of Flame and my upcoming self-hosted and open source projects you can use the following link: [![PayPal Badge](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white)](https://www.paypal.com/paypalme/pawelmalak)