{"id":13547104,"url":"https://github.com/hywax/mafl","last_synced_at":"2025-05-16T05:04:17.038Z","repository":{"id":213877192,"uuid":"735151489","full_name":"hywax/mafl","owner":"hywax","description":"Minimalistic flexible homepage","archived":false,"fork":false,"pushed_at":"2025-05-13T19:03:24.000Z","size":9565,"stargazers_count":504,"open_issues_count":41,"forks_count":36,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-13T20:32:06.945Z","etag":null,"topics":["application","dashboard","docker","homepage","productivity","proxmox","self-hosted","startpage"],"latest_commit_sha":null,"homepage":"https://mafl.hywax.space","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hywax.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"custom":"https://boosty.to/hywax"}},"created_at":"2023-12-23T21:08:47.000Z","updated_at":"2025-05-11T06:56:58.000Z","dependencies_parsed_at":"2023-12-28T13:32:18.020Z","dependency_job_id":"08f4359a-df1c-4cac-9cce-4262348fb7ec","html_url":"https://github.com/hywax/mafl","commit_stats":null,"previous_names":["hywax/mafl"],"tags_count":43,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hywax%2Fmafl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hywax%2Fmafl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hywax%2Fmafl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hywax%2Fmafl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hywax","download_url":"https://codeload.github.com/hywax/mafl/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254471061,"owners_count":22076585,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["application","dashboard","docker","homepage","productivity","proxmox","self-hosted","startpage"],"created_at":"2024-08-01T12:00:51.022Z","updated_at":"2025-05-16T05:04:17.012Z","avatar_url":"https://github.com/hywax.png","language":"TypeScript","funding_links":["https://boosty.to/hywax"],"categories":["TypeScript","Projects","Container Operations","Examples"],"sub_categories":["Hosted","User Interface"],"readme":"\u003ch1 align=\"center\"\u003eMafl\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n  \u003ci\u003eMafl is an intuitive service for organizing your homepage. Customize Mafl to your individual needs and work even more efficiently!\u003c/i\u003e\n  \u003cbr/\u003e\u003cbr/\u003e\n  \u003cimg width=\"130\" alt=\"Mafl\" src=\"https://raw.githubusercontent.com/hywax/mafl/main/docs/public/logotype.svg\"/\u003e\n  \u003cbr/\u003e\u003cbr/\u003e\n  \u003cb\u003e\u003ca href=\"https://mafl.hywax.space/community/showcase.html\"\u003eUser Showcase\u003c/a\u003e\u003c/b\u003e | \u003cb\u003e\u003ca href=\"https://mafl.hywax.space\"\u003eDocumentation\u003c/a\u003e\u003c/b\u003e | \u003cb\u003e\u003ca href=\"https://github.com/hywax/mafl\"\u003eGitHub\u003c/a\u003e\u003c/b\u003e\n  \u003cbr/\u003e\u003cbr/\u003e\n  \u003ca href=\"https://github.com/hywax/mafl/blob/main/CHANGELOG.md\"\u003e\u003cimg src=\"https://img.shields.io/github/package-json/v/hywax/mafl?logo=hackthebox\u0026color=609966\u0026logoColor=fff\" alt=\"Current Version\"/\u003e\u003c/a\u003e\n  \u003ca target=\"_blank\" href=\"https://github.com/hywax/mafl\"\u003e\u003cimg src=\"https://img.shields.io/github/last-commit/hywax/mafl?logo=github\u0026color=609966\u0026logoColor=fff\" alt=\"Last commit\"/\u003e\u003c/a\u003e\n  \u003ca target=\"_blank\" href=\"https://hub.docker.com/r/hywax/mafl\"\u003e\u003cimg src=\"https://img.shields.io/docker/pulls/hywax/mafl?logo=docker\u0026color=609966\u0026logoColor=fff\" alt=\"Docker pulls\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/hywax/mafl/blob/main/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/License-MIT-609966?logo=opensourceinitiative\u0026logoColor=fff\" alt=\"License MIT\"/\u003e\u003c/a\u003e\n  \u003cbr/\u003e\u003cbr/\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/hywax/mafl/main/docs/public/cover.png\" alt=\"Mafl\" width=\"100%\"/\u003e\n\u003c/p\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cb\u003eTable of Contents\u003c/b\u003e\u003c/summary\u003e\n\n* [Features](#-features)\n* [Getting started](#-getting-started)\n  * [Docker](#docker)\n  * [Node](#node)\n  * [Proxmox](#proxmox)\n* [Services](#-services)\n* [Themes](#-themes)\n* [Icons](#-icons)\n* [Languages](#-multi-language)\n* [Credits](#-credits)\n  * [Contributors](#contributors)\n* [License](#-license)\n\u003c/details\u003e\n\n## 🎯 Features\n\n* 🔐 **Privacy**. All requests to third-party services occur in backend.\n* ⚡ **Real-time**. Interactive cards with extra information.\n* 🌎 **Multi-language**. Supports multiple languages.\n* 🎨 **Themes**. Customize the look to your liking.\n* 🗂️ **Grouping**. Create custom service groups.\n* 🏷️ **Tags**. Add tags to your services.\n* 👌 **Easy setup**. A few lines of yaml and your homepage is ready to go.\n* 🚀 **Fast**. Everything is fast and free of hang-ups.\n* 🐳 **Docker**. Optimized docker images for popular platforms.\n* ✨ **Free**. Mafl is completely free and open source.\n* 📲 **PWA**. Installable application.\n\n## 🚀 Getting started\n\n### Docker\n\nThis Docker image is published to both Docker Hub and the GitHub container registry. Depending on your preferences and needs, you can reference both `hywax/mafl` as well as `ghcr.io/hywax/mafl`.\n\n```yaml\nversion: '3.8'\n\nservices:\n  mafl:\n    image: hywax/mafl\n    restart: unless-stopped\n    ports:\n      - '3000:3000'\n    volumes:\n      - ./mafl/:/app/data/\n```\n\n### Node\n\nFirst, clone the repository:\n\n```shell\ngit clone https://github.com/hywax/mafl.git\n```\n\nThen install dependencies and build the production bundle (I'm using `yarn` here, you can use `npm` or `pnpm` if you like):\n\n```shell\nyarn install\nyarn build\n```\n\nFinally, run the server:\n\n```shell\nyarn preview\n```\n\nThe application will start with a basic configuration, which is located in the `data` folder.\n\n### Proxmox\n\nTo create a new Proxmox VE Mafl LXC, run the command below in the Proxmox VE Shell.\n\n```shell\nbash -c \"$(wget -qLO - https://github.com/community-scripts/ProxmoxVE/raw/main/ct/mafl.sh)\"\n```\n\nConfigure the application by editing the `config.yml` file:\n\n```shell\nnano /opt/mafl/data/config.yml\n```\n\nMany thanks to [@tteck](https://github.com/tteck) for helping me create lxc script.\n\n## 📊 Services\n\nThe basic concept of `Mafl` is to create not just a homepage, but to create an interactive homepage page. You can combine different services with each other. You can combine different services to create the perfect customized homepage for you.\n\nList of services:\n* **[Base](https://mafl.hywax.space/services/base.html)** - The main card of the service. Other services are created on the basis of this service.\n* **[IP API](https://mafl.hywax.space/services/ip-api.html)** - Shows information about your IP address.\n* **[Weather](https://mafl.hywax.space/services/openweathermap.html)** - Shows weather information for your location.\n\n## 🎨 Themes\n\nThere are several ready-made themes in `Mafl`. But nothing prevents you from creating your own design themes and sharing them with other users\n\n\u003cimg src=\"https://raw.githubusercontent.com/hywax/mafl/main/docs/public/themes.png\" alt=\"Mafl themes\" width=\"100%\"/\u003e\n\n## 🖼 Icons\n\nServices can have icons. With support for several different icon packs, you can find the perfect thumbnail for any application or service.\n\nSupported types:\n* **[Iconify](https://icon-sets.iconify.design/)** - Over 200,000 open source vector icons\n* **Emoji** - Any valid emoji can be used as an icon\n* **URL** - Pass the URL of any matching image so that it can be found and displayed.\n* **Local** - Store custom images locally and reference them by file name\n\n## 🌎 Multi-language\n\n`Mafl` supports multiple languages and locales. The app should automatically detect your language and set it in the settings. If not, set it in `config.yml` with the `lang` property.\n\nSupported Languages:\n* 🇬🇧 **English** - `en`\n* 🇷🇺 **Russian** - `ru`\n* 🇨🇳 **Chinese** - `zh`\n* 🇨🇮 **Hindi** - `hi`\n* 🇪🇸 **Spanish** - `es`\n* 🇸🇦 **Arabic** - `ar` (by [@mohmadhabib](https://github.com/mohmadhabib))\n* 🇵🇱 **Polish** - `pl` (by [@UberDudePL](https://github.com/UberDudePL))\n* 🇫🇷 **France** - `fr` (by [@maxim31cote](https://github.com/maxim31cote))\n* 🇩🇪 **German** - `de` (by [@gehno](https://github.com/gehno))\n* 🇬🇷 **Greek** - `gr` (by [@sthivaios](https://github.com/sthivaios))\n\nIf you haven't found your language, it can easily be added! Use the instructions in the section [contributing](https://mafl.hywax.space/community/contributing.html) on docs.\n\n## 🏆 Credits\n\nA huge thank you to everyone who is helping to improve Mafl. Thanks to you, the project can evolve!\n\n### Contributors\n\nTo become a contributor, please follow our [contributing guide](https://mafl.hywax.space/community/contributing.html).\n\n\u003cimg src=\"https://raw.githubusercontent.com/hywax/mafl/main/docs/public/contributors.svg\" alt=\"Mafl Contributors\" width=\"100%\"/\u003e\n\n## 📄 License\n\nThis app is open-sourced software licensed under the [MIT license](https://github.com/hywax/mafl/blob/main/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhywax%2Fmafl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhywax%2Fmafl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhywax%2Fmafl/lists"}