beenull/flame
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Flame is self-hosted startpage for your server. Easily manage your apps and bookmarks with built-in editors.
71 commits 27 branches 17 tags 4.5 MiB
TypeScript 70.4%
JavaScript 22%
CSS 5.2%
Python 1.5%
HTML 0.6%
Other 0.3%
Find a file
pawelmalak 4ca3b509cf
Merge branch 'master' into feature
2021-06-18 15:12:36 +02:00
client Fixed bug with decimal input values in Safari browser 2021-06-18 14:12:17 +02:00
controllers Sorting and custom ordering for categories 2021-06-18 13:42:55 +02:00
github Small changes to CSS. README.md with screenshots 2021-06-08 12:51:50 +02:00
middleware Docker build. Catch client routes on server. Initial config utility 2021-06-07 13:40:51 +02:00
models Sorting settings. Sort apps on change/add/update 2021-06-18 10:38:05 +02:00
routes Sorting and custom ordering for categories 2021-06-18 13:42:55 +02:00
utils Preparation for custom sorting 2021-06-17 10:56:27 +02:00
.dockerignore Small changes to CSS. README.md with screenshots 2021-06-08 12:51:50 +02:00
.env Case-insensitive sorting. App version checking 2021-06-15 12:36:23 +02:00
.gitignore Case-insensitive sorting. App version checking 2021-06-15 12:36:23 +02:00
api.js Docker build. Catch client routes on server. Initial config utility 2021-06-07 13:40:51 +02:00
db.js Added ability to set icons on bookmarks. Added hover indicator for apps 2021-06-09 12:45:55 +02:00
docker-compose.yml Fixed infinite data fetching bug on homescreen. Docker files 2021-06-14 12:13:38 +02:00
Dockerfile Fixed typo in Dockerfile. Added some checks to weather module settings 2021-06-09 22:26:39 +02:00
Dockerfile.multiarch Fixed infinite data fetching bug on homescreen. Docker files 2021-06-14 12:13:38 +02:00
LICENSE.md Added License file 2021-06-10 13:44:03 +02:00
package-lock.json Bump ws from 7.4.5 to 7.4.6 2021-06-08 23:22:59 +00:00
package.json Bump ws from 7.4.5 to 7.4.6 2021-06-08 23:22:59 +00:00
README.md Fixed bug with decimal input values in Safari browser 2021-06-18 14:12:17 +02:00
server.js Docker build. Catch client routes on server. Initial config utility 2021-06-07 13:40:51 +02:00
Socket.js Fixed bug related to websocket protocol which was making app unusable with reverse proxy and https 2021-06-11 00:09:25 +02:00
Sockets.js Added WebSockets with funcionality to send messages from any module 2021-05-19 17:17:24 +02:00

README.md

Flame

JS Badge TS Badge Node Badge React Badge

Homescreen screenshot

Description

Flame is self-hosted startpage for your server. Its design is inspired (heavily) by 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
    • Redux
    • TypeScript
  • Deployment
    • Docker

Development

# clone repository
git clone https://github.com/pawelmalak/flame
cd flame

# run only once
npm run dev-init

# start backend and frontend development servers
npm run dev

Building Docker images

# build image for amd64 only
docker build -t flame .

# build multiarch image for amd64, armv7 and arm64
# building failed multiple times with 2GB memory usage limit so you might want to increase it
docker buildx build \
  --platform linux/arm/v7,linux/arm64,linux/amd64 \
  -f Dockerfile.multiarch \
  -t flame:multiarch .

Deployment with Docker

# run container
docker run -p 5005:5005 -v /path/to/data:/app/data flame

Functionality

  • Applications
    • Create, update and delete applications using GUI
    • Pin your favourite apps to homescreen

Homescreen screenshot

  • Bookmarks
    • Create, update and delete bookmarks and categories using GUI
    • Pin your favourite categories to homescreen

Homescreen screenshot

  • Weather
    • Get current temperature, cloud coverage and weather status with animated icons
  • Themes
    • Customize your page by choosing from 12 color themes

Homescreen screenshot

Usage

Supported URL formats for applications and bookmarks

Rules

  • URL starts with http://
    • Format: http://www.domain.com, http://domain.com
    • Redirect: {dest}
  • URL starts with https://
    • Format: https://www.domain.com, https://domain.com
    • Redirect: https://{dest}
  • URL without protocol
    • Format: www.domain.com, domain.com, sub.domain.com, local, ip, ip:port
    • Redirect: http://{dest}

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