Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/enchant97/web-portal
Web Portal is a all-in-one web dashboard, providing many widgets to build a personal portal. With the ability to load external plugins.
https://github.com/enchant97/web-portal
asynchronous asyncio dashboard mysql portal python python3 quart self-hosted sqlite tortoise-orm webapp
Last synced: 27 days ago
JSON representation
Web Portal is a all-in-one web dashboard, providing many widgets to build a personal portal. With the ability to load external plugins.
- Host: GitHub
- URL: https://github.com/enchant97/web-portal
- Owner: enchant97
- License: agpl-3.0
- Created: 2021-02-09T13:11:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-25T13:59:49.000Z (7 months ago)
- Last Synced: 2024-06-19T03:11:36.468Z (3 months ago)
- Topics: asynchronous, asyncio, dashboard, mysql, portal, python, python3, quart, self-hosted, sqlite, tortoise-orm, webapp
- Language: Python
- Homepage: http://webportal.docs.enchantedcode.co.uk/
- Size: 915 KB
- Stars: 182
- Watchers: 3
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-homelab - Web Portal - portal?style=flat) ![Web Portal](https://img.shields.io/github/languages/top/enchant97/web-portal?style=flat) | Web Portal is a all-in-one web dashboard, providing many widgets to build a personal portal. With the ability to load external plugins. | (Apps / Dashboard)
README
# Web Portal
![GitHub](https://img.shields.io/github/license/enchant97/web-portal?style=flat-square)
![Supported Python Version](https://img.shields.io/badge/python%20version-3.11-blue?style=flat-square)
![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/enchant97/web-portal?include_prereleases&label=latest%20release&style=flat-square)Web Portal is a all-in-one web dashboard, providing many widgets to build a personal portal. With the ability to load external plugins.
It has been designed to run through docker and it is recommended to put it behind a proxy like Nginx for custom routing and domain names.
If you want just a basic link panel configured with a yaml file checkout Web Portal Lite available here: .
## Features
- Minimal use of Javascript, to provide a lightning fast experience
- Icon based UI
- Minimal docker image (if deployed with docker)
- Adjustable site theme
- Plugin support
- Inbuilt Plugin Widgets
- Core
- Digital Clock
- Links
- Groups
- Colors
- Icons
- Search bar
- Core-Extras
- HTML embed
- Website embed (through iframe)
- Password protection for admin modification
- Optionally secure the portal with user accounts & passwords
- MySQL & SQLite support## Showcase
[![web-portal showcase image, showing dark and light themes](docs/assets/portal-view.png)](docs/assets/portal-view.png)## Demo Video
WIP## Third-Party Plugins
It is encouraged to extend and build upon this app to make it the ultimate dashboard.Here are some ideas:
- Server status widget
- Home Automation
- Messages widget (leave messages for users)You can discuss plugins [here](https://github.com/enchant97/web-portal/discussions/categories/third-party-plugins).
## Branches
| Name | Description | State |
| :----------- | :--------------------- | :------------ |
| main | Work ready for release | Stable |
| next | Work for next version | Very Unstable |
| historical-X | Historical versions | Unsupported |> Choose a tag/release for most stable if running project
## Contributions
Contributing to this project is welcome, whether that is an issue or pull request, but please read the guidelines below:- Contributions may get rejected, if they do not fit the project
- New widgets most likely will not be added, instead make a plugin (feel free to add the idea to the GitHub discussions page, [here](https://github.com/enchant97/web-portal/discussions/categories/ideas))
- You should keep code to this existing style/format
- Contributions should not require more pip packages from being added, although there may be exceptions
- Contributions must be licensed under the same as the project
- Submit pull requests to 'next' branch, please include some details of what the Contribution is
- Don't change the version number## Documentation
More details and guides on installing can be found at: [webportal.docs.enchantedcode.co.uk/](https://enchantedcode.co.uk/web-portal/) or view the markdown in the `docs` folder [here](docs/index.md).## License
This project is Copyright (c) 2024 Leo Spratt, licences shown below:Code
AGPL-3 or any later version. Full license found in `LICENSE.txt`
Documentation
FDLv1.3 or any later version. Full license found in `docs/LICENSE.txt`
This project also uses some third party content, licences for those are found at: `THIRD-PARTY.txt`.