https://github.com/jamesread/faridoon

Publish your favourite chat quotes.
https://github.com/jamesread/faridoon

webapp

Last synced: 9 months ago
JSON representation

Publish your favourite chat quotes.

• Host: GitHub
• URL: https://github.com/jamesread/faridoon
• Owner: jamesread
• License: agpl-3.0
• Created: 2013-06-22T20:38:23.000Z (almost 13 years ago)
• Default Branch: main
• Last Pushed: 2025-01-07T22:29:58.000Z (over 1 year ago)
• Last Synced: 2025-01-07T23:41:10.368Z (over 1 year ago)
• Topics: webapp
• Language: PHP
• Homepage: https://jamesread.github.io/Faridoon/
• Size: 2.59 MB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


  

  
Faridoon


  Easily save and publish your favourite chat quotes for others to see.

[![Static Badge](https://img.shields.io/badge/maturity-Production-brightgreen)](#none)

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/jamesread/Faridoon/release-pipeline.yml?link=https%3A%2F%2Fgithub.com%2Fjamesread%2Ffaridoon%2Factions%2Fworkflows%2Frelease-pipeline.yml)

[![Discord](https://img.shields.io/discord/846737624960860180?label=Discord%20Server)](https://discord.gg/jhYWWpNJ3v)

Documentation for how to install and use Faridoon is available at https://jamesread.github.io/Faridoon/



## Screenshots 

Note the screenshots below contain quotes from the site that inspired this self hosted project - bash.org - which is now offline. There are several mirrors available via search engines. These quotes were used because they've been shared wildly for over 2 decades, and they're pretty funny :-) 

![Faridoon Mobile Phone Screenshot](var/mockupLaptop.png)

![Faridoon Desktop Screenshot](var/mockupMobilePhone.png)

## Getting Started

Documentation is available at: https://jamesread.github.io/Faridoon/ , the recommended installation method is via **Docker**, connected to a **MySQL Database**. Faridoon runs just fine with low system resources - 1 vCPU and a 1 GB of RAM is plenty. 

## Features

* Automatic highlighting of usernames.

* Semi-intelligent removal of line breaks and weird characters.

* User login and registration, with support for admins and non-admins.

* Approval system for guest and non-admin submissions.

* Easy configuration via environment variables, or configuration file.

## **Faridoon is a No-Nonsense Open Source project;**

- All code and assets are Open Source (AGPL).

- No company is paying for development, there is no paid-for support from the developers.

- No separate core and premium version, no plus/pro version or paid-for extra features.

- No SaaS service or "special cloud version".

- No "anonymous data collection", usage tracking, user tracking, telemetry or email address collection.

- No requests for reviews in any "app store" or feedback surveys.

- No prompts to "upgrade to the latest version".

- No internet-connection required for any functionality.

## Docs

Documentation for how to install and use Faridoon is available at https://jamesread.github.io/Faridoon/