mastowall/README.md

77 lines
4.1 KiB
Markdown
Raw Permalink Normal View History

# Mastowall 1.1
2023-05-17 10:58:03 +02:00
2023-05-20 03:57:10 +02:00
Mastowall is a social wall application that displays posts from the [Mastodon](https://joinmastodon.org/) social network based on specified hashtags. It was written entirely by [ChatGPT4](https://openai.com/product/gpt-4), guided only by text prompts.
2023-05-17 10:58:03 +02:00
2023-05-19 16:30:52 +02:00
<img width="1435" alt="image" src="https://github.com/rstockm/mastowall/assets/3195116/af1a3786-335b-4d64-b387-0db75dd73040">
2023-05-18 11:41:27 +02:00
Try it live: [Mastowall for the BiblioCon conference](https://rstockm.github.io/mastowall/?hashtags=111bibliocon,bibliocon,bibliocon23&server=https://openbiblio.social))
2023-05-18 11:43:56 +02:00
Use your own hashtags and server:
2023-05-19 16:30:52 +02:00
<img width="1164" alt="image" src="https://github.com/rstockm/mastowall/assets/3195116/97814e5b-5377-426a-bfff-78be8f560421">
JSON config file:
<img width="567" alt="image" src="https://github.com/rstockm/mastowall/assets/3195116/27fe7f0b-c79e-4539-ac44-053ea5d3f101">
2023-05-18 11:41:27 +02:00
2023-05-18 03:58:22 +02:00
## Features
2023-05-17 10:58:03 +02:00
2023-05-18 03:58:22 +02:00
- **Display Posts:** The app fetches and displays posts from Mastodon based on the hashtags provided in the URL. If no hashtags are provided, it presents a form to enter up to three hashtags.
2023-05-17 10:58:03 +02:00
2023-05-18 11:39:12 +02:00
- **Custom Mastodon Server:** Allows users to specify a Mastodon server URL from which to fetch posts.
2023-05-18 03:58:22 +02:00
- **Real-Time Updates:** Mastowall updates the posts every 10 seconds, ensuring that the content displayed is always current.
2023-05-17 10:58:03 +02:00
2023-05-18 03:58:22 +02:00
- **Relative Timestamps:** The timestamps of the posts are displayed relative to the current time, and are updated every minute to reflect the passing time.
- **Masonry Grid Layout:** The posts are displayed in a masonry grid layout for a visually pleasing experience.
- **Responsive Design:** The layout adjusts according to the screen size for better readability on different devices.
- **Navbar Hashtag Navigation:** Clicking on the hashtags in the navbar takes you to the form screen, allowing you to change the existing hashtags easily.
2023-05-19 16:30:52 +02:00
- **Navbar Color Customization:** The color of the navigation bar can now be customized via the `config.json` file.
- **Including Replies:** By default, replies are excluded from the wall. However, this behavior can be changed by setting includeReplies to true in the `config.json` file.
2023-05-18 03:58:22 +02:00
## Technology Stack
Mastowall is built using the following technologies:
- **HTML, CSS, and JavaScript**: For structuring, styling, and functionality.
2023-05-18 11:39:12 +02:00
- **[jQuery](https://jquery.com/)**: A fast, small, and feature-rich JavaScript library.
2023-05-18 03:58:22 +02:00
2023-05-18 11:39:12 +02:00
- **[Masonry](https://masonry.desandro.com/)**: A JavaScript grid layout library.
2023-05-18 03:58:22 +02:00
2023-05-18 11:39:12 +02:00
- **[Bootstrap](https://getbootstrap.com/)**: A popular CSS framework for responsive, mobile-first front-end web development.
2023-05-18 03:58:22 +02:00
- **[DOMPurify](https://github.com/cure53/DOMPurify)**: Library for sanitizing HTML input, which should prevent the vast majority of malicious input from being rendered
2023-05-18 03:58:22 +02:00
## Usage
2023-05-18 11:39:12 +02:00
1. Load the application in a web browser. If no hashtags are specified in the URL, you will be presented with a form to enter up to three hashtags and a server URL.
2023-05-18 03:58:22 +02:00
2023-05-18 11:39:12 +02:00
2. After entering your hashtags and clicking 'Reload', the application will fetch and display posts from the specified Mastodon server that include those hashtags.
2023-05-18 03:58:22 +02:00
3. The displayed posts will update every 10 seconds. The relative timestamps will also update every minute.
4. To change the hashtags, click on them in the navbar to go back to the form screen.
2023-05-17 10:58:03 +02:00
2023-05-18 03:58:22 +02:00
## Sharing via URL
2023-05-17 10:58:03 +02:00
2023-05-18 11:39:12 +02:00
Mastowall supports URL parameters to easily share specific hashtag configurations and the Mastodon server. Simply append the desired hashtags and the server URL to the URL following this format: `?hashtags=hashtag1,hashtag2,hashtag3&server=serverUrl`
2023-05-17 10:58:03 +02:00
Enjoy using Mastowall!
2023-05-18 04:05:09 +02:00
## AI-Guided Development: A Proof of Concept
2023-05-19 16:31:36 +02:00
Mastowall may serve as an example of how artificial intelligence can aid and accelerate the software development process. The development of this version of the app was guided by OpenAI's GPT-4, a large language model.
2023-05-18 04:05:09 +02:00
In this process, the human developer posed problems, asked questions, and described the desired features and functionalities of the application. GPT-4 then provided solutions, answered queries, generated code snippets, and suggested optimal ways to implement these features.
2023-05-18 11:39:12 +02:00
Every single line of code was written by ChatGPT4.
2023-05-18 11:45:37 +02:00
Including this README.