~akspecs/aqoli-docs

documentation for aqoli
95d5b2f6 — Andrei Khartchenko 6 months ago
repo-organization.txt: indicate TODO is complete
262607f9 — Andrei Khartchenko 6 months ago
add repo-organization.txt
dcd0fb78 — Andrei Khartchenko 7 months ago
docs: add submitting_a_patch.md

refs

master
browse  log 

clone

read-only
https://git.sr.ht/~akspecs/aqoli-docs
read/write
git@git.sr.ht:~akspecs/aqoli-docs

You can also use your local clone with git send-email.

#aqoli - Aggregated Quality of Life Indices

License: AGPL. Discussion on Matrix.

#aqoli is a front-end web interface to quality of life living metrics

browse and compare aggregated quality of life indices with the help of this website

#numbeo-scraping is a set of scrapy spiders that will crawl numbeo.com

with the help of a turn-key script, run all of the spiders in numbeo-scraping and create/update the database used by the aqoli front-end!

See aqoli/numbeo-scraping features: docs/features.md

Join the aqoli/numbeo scraping discussion room on Matrix: #2021 fall cs195 general:matrix.org

See also: aqoli, a front-end for the scraped data.

#Instances

The official instance is on https://example.com.

Community instances are listed in docs/instances.md. Submit a patch to add your own instance to that list.

#Installing

See docs/installing_basic.md and docs/installing_extended.md.

#Contributing

#Credits & license information

All of aqoli's code uses the AGPL 3.0 license. In short, this means that if you make any modifications to the code and then publish the result (e.g. by hosting the result on a webserver), you must publicly distribute your changes and declare that they also use AGPL 3.0.

The documentation uses the Unlicense.