Add a background graphic;

Add more information to the file README.
This commit is contained in:
Schimon Jehudah, Adv. 2024-10-08 15:20:29 +03:00
parent 95c1f30ebc
commit 0d2e55fa14
2 changed files with 97 additions and 1 deletions

View file

@ -10,16 +10,62 @@ browsers.
It also provides an interface to explore XMPP server conferences, pubsub and It also provides an interface to explore XMPP server conferences, pubsub and
other services. other services.
### Reasons for creating of FASI
The main reasons for the realization of FASI are:
- Add interactive capabilities, as well as vCard information;
- Create rapport with the viewers, by displaying vCard information, such as Full
Name and Description or Note;
- Charm our "normie" friends, so called, by displaying an attractive contact
HTML page, which they can also utilize;
- Utilize an invitation page, with XMPP capabilities, regardless to the software
that powers an XMPP server;
- Realize that HTTP is obsolete and should be treated as an optional publishing
mean, because anything that HTTP offers, is already possible with XMPP, since
a couple of decades ago.
### Special features
- Fetch vCards and photos;
- Indicate of available conferences, nodes and services;
- Retrieve number of conferences, nodes, participants, node items and services;
- Preview recent conference messages;
- View journal articles (i.e. PubSub node items that are published as Atom Over
XMPP).
### Byproduct
- Browse services;
- Explore JID and node items.
### Other features
- Customization for specific brands (e.g. monocles chat);
- Dynamic background in accordance to the photo colors.
## Technicalities
FASI is written in Python and utilizes Jinja2, FastAPI and Slixmpp. FASI is written in Python and utilizes Jinja2, FastAPI and Slixmpp.
FASI require an XMPP account to work, it only needs an XMPP server.
## Features ## Features
- MUC - MUC
- Photo - Photo
- PubSub - PubSub
- QR code - QR code
- Service discovery - Service Discovery
- vCard - vCard
## XEP
- XEP-0030: Service Discovery
- XEP-0045: Multi-User Chat
- XEP-0054: vcard-temp
- XEP-0060: Publish-Subscribe
## Install ## Install
Use the following commands, to begin FASI. Use the following commands, to begin FASI.
@ -37,3 +83,8 @@ AGPL-3.0-only
## Copyright ## Copyright
Schimon Jehudah Zachary 2024 Schimon Jehudah Zachary 2024
# Similar Projects
- [Easy XMPP Invitation Landing Page](https://github.com/modernxmpp/easy-xmpp-invitation) from Mr. Georg Lukas;
- [mod_invite](https://modules.prosody.im/mod_invite.html) module for Prosody.

45
img/background.svg Normal file
View file

@ -0,0 +1,45 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
version="1.1"
id="svg1"
width="80"
height="92"
viewBox="0 0 80 92"
sodipodi:docname="background_0004.svg"
inkscape:version="1.3.2 (091e20ef0f, 2023-11-25, custom)"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns="http://www.w3.org/2000/svg"
xmlns:svg="http://www.w3.org/2000/svg">
<defs
id="defs1" />
<sodipodi:namedview
id="namedview1"
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1.0"
inkscape:showpageshadow="2"
inkscape:pageopacity="0.0"
inkscape:pagecheckerboard="0"
inkscape:deskcolor="#d1d1d1"
inkscape:zoom="5.9"
inkscape:cx="39.830508"
inkscape:cy="47.033898"
inkscape:window-width="1916"
inkscape:window-height="1032"
inkscape:window-x="0"
inkscape:window-y="22"
inkscape:window-maximized="1"
inkscape:current-layer="g1" />
<g
inkscape:groupmode="layer"
inkscape:label="Image"
id="g1">
<path
style="fill:none;stroke:#dadada"
d="M 7.9933697,3.8536538e-4 C 8.0070897,20.71715 22.520416,14.85765 32.522174,28.28434 c 3.71128,4.98214 2.20517,13.84718 2.13272,19.71605 C 34.426664,66.48723 19.361635,62.39385 10.131229,73.8543 6.4409207,78.43618 7.9933697,86.63903 7.9933697,92.0004 M 71.993374,3.8536538e-4 C 71.978074,19.85167 56.686694,14.9665 47.464564,28.1403 c -4.0466,5.78057 -2.40551,17.09222 -2.11214,23.86009 0.62031,14.31026 16.82256,13.46918 24.50308,22.18312 3.72915,4.23091 2.13787,12.56287 2.13787,17.81689"
id="path1" />
</g>
</svg>

After

Width:  |  Height:  |  Size: 1.7 KiB