annotate README.md @ 1618:5d9889f14012 default tip @

server: start major redesign - Add icons to menu items - Switch menu items representation from tuple to dictionary for future extensibility: - Include icon information - Prepare for additional data - Remove "login" from main menu, add login page URL to template data, as it is now a separate right-aligned item
author Goffi <goffi@goffi.org>
date Sat, 26 Oct 2024 23:07:01 +0200
parents 4542569d2b89
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1520
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
1 # Libervia Web
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
2
1520
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
3 ### Copyrights
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
4
1520
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
5 - Jérôme Poisson aka Goffi 2008-2023
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
6 - Adrien Cossa aka Souliane 2013-2016
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
7 - Additional contributions by community members
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
8
1520
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
9 ## License
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
10
1567
4542569d2b89 README: name is now "Libervia Web"
Goffi <goffi@goffi.org>
parents: 1520
diff changeset
11 Libervia Web is a Libre software (Free as in "Freedom"), distributed under the
4542569d2b89 README: name is now "Libervia Web"
Goffi <goffi@goffi.org>
parents: 1520
diff changeset
12 AGPL v3+ license. For the full license, please refer to the `COPYING` file.
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
13
1520
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
14 ## Relevant URLs
790
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
15
1520
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
16 Here are some useful URLs, all of which (except for the source code repository) are
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
17 powered by Libervia itself, showcasing the flexibility and versatility of the tool:
790
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
18
1520
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
19 - Official Website: <https://libervia.org>
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
20 - Documentation: <https://libervia.org/documentation/web>
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
21 - Bug Tracker: <https://libervia.org/tickets>
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
22 - Source Code: <https://repos.goffi.org/libervia-web/>
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
23 - News: <https://libervia.org/news> (currently the same as the blog below)
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
24 - Main Developer's Blog: <https://www.goffi.org/>
714
03e9fe91081c browser_side: use favico.js to display alerts counter
souliane <souliane@mailoo.org>
parents: 685
diff changeset
25
1520
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
26 Additionally, our blogs are accessible via ActivityPub thanks to the Libervia XMPP <=>
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
27 ActivityPub gateway.
526
ee38b6a87692 add licence information for otr.js and dependencies
souliane <souliane@mailoo.org>
parents: 385
diff changeset
28
1520
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
29 ## About
790
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
30
1520
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
31 Libervia Web is the official web frontend of the Libervia project. It is designed to be
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
32 user-friendly and offers a wide range of features including instant messaging, blogs,
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
33 forums, photo albums, file sharing, event organization, personal agendas, and various
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
34 kinds of lists (tickets, TODOs, shopping, etc.). Upcoming enhancements include the
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
35 addition of video calls. Libervia Web is an all-encompassing, universally compatible tool,
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
36 ideal for individuals, small and large groups, associations, internal communication,
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
37 public-facing websites, and private social networks.
790
b3a2c34320e6 update README
Goffi <goffi@goffi.org>
parents: 714
diff changeset
38
1520
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
39 The platform includes an easy-to-use invitation system, which simplifies the process of
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
40 bringing new members into the network. This system allows people to participate even if
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
41 they don't have an account.
60
d9f4a3256da8 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
42
1520
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
43 Leveraging the power of [Brython](https://www.brython.info/), Python can be utilized both
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
44 server-side and in the browser. In essence, Libervia Web is a web framework created with
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
45 Python, capitalizing on the robustness of XMPP and Libervia for data management. This
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
46 makes it highly customizable, enabling the frontend to be easily adapted for specific use
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
47 cases or themes.
384
8bb9c878b7e3 README update
Goffi <goffi@goffi.org>
parents: 340
diff changeset
48
1520
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
49 For additional information, please visit the [Official Website](https://libervia.org) or
88f99488e604 doc: update README to be more concise, and just talk about the frontend
Goffi <goffi@goffi.org>
parents: 1396
diff changeset
50 the [Libervia Backend Repository](https://repos.goffi.org/libervia-backend).