egoport/README.md
2023-11-20 19:32:02 +01:00

66 lines
No EOL
3 KiB
Markdown

# EGOport
A place to call your home on the interwebs
## Why
Ever felt like you need to have a privacy-respecting alternative for everything? Well now you can have a privacy-respecting front-page for yourself. The pride of this project is fetching all the displayed data on the server, so your visitors don't need to send X different `GET` requests to different APIs.
Next pro comes in the form of customization. By fetching the raw data and ~~formatting it~~ trying to format it into a reasonable JSON object, you are not limited by some embed image returned by a server. Let your creativity flow into your theme, which can be made by simply throwing some HTML and CSS together. Or if you're lazy, just use some of the pre-made ones (unless you use the ones I made, they are ugly).
## Configuration
TODO
## Roadmap
- [X] Easy theme switching
- [] Actual caching!!!!!
- [] ListenBrainz current/last listening
- [] Contact form that sends stuff somewhere
- [] Shoutbox
- [] Discord online/offline??? (idk probably needs a bot)
- [] Fetch latest Mastodon post
- [] Follower counts for different sites
- [X] Dynamically add custom pages
- [] Mini CMS blog
## License
```
EGOport
Copyright (C) 2023 Matyáš Caras
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License version 3 as
published by the Free Software Foundation.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
You may find additional permissions in the "EXCEPTIONS.md" file.
```
The base project was bootstrapped from [fastify-typescript-starter](https://github.com/yonathan06/fastify-typescript-starter)
```
Copyright (c) 2020 Yonatan
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```