No description
Find a file
2020-11-08 14:49:49 +01:00
app Make path handling less horrific. 2020-11-07 19:38:01 +01:00
.gitignore First commit after re-import. 2020-11-07 15:34:48 +01:00
CONTRIBUTING.md First commit after re-import. 2020-11-07 15:34:48 +01:00
LICENSE First commit after re-import. 2020-11-07 15:34:48 +01:00
prod.ini Refactor dev/prod setup. 2020-11-07 16:12:31 +01:00
README.md First commit after re-import. 2020-11-07 15:34:48 +01:00
requirements.txt First commit after re-import. 2020-11-07 15:34:48 +01:00
run-dev.sh Refactor dev/prod setup. 2020-11-07 16:12:31 +01:00
run-prod.sh Move run-prod.sh to use prod.ini. 2020-11-08 14:49:49 +01:00

To use

This Agora Server is meant to be used in conjunction with an Agora. An Agora is a collection of digital gardens and other information sources that are assembled into a distributed knowledge graph.

For an example Agora, and for more information on the Agora design, please refer to https://flancia.org/go/agora.

To see the Agora Server in action with the example Agora, please visit https://anagora.org.

To develop

Install OS dependencies:

$ apt-get install python3 python3-venv python3-pip

Then Flask inside a virtual environment in this directory:

python3 -m venv venv
. venv/bin/activate
pip install -r requirements.txt

Then run the development server:

./run.sh

Optional: my git configuration

(Tangent) in case this is your first git contribution/you just haven't done it and you find this useful. This is my git config:

git config --global user.email "example@example.org"
git config --global user.name "Example"
git config --global alias.st status
git config --global alias.ci commit
git config --global alias.co checkout
git config --global alias.f "reset --hard HEAD"

About the project

As you might have inferred from the above, this project is based on Flask. /app hosts the Flask app. In it:

/templates are Jinja2 templates. __init__.py has the high level Flask setup. agora.py does rendering (url maps, views). db.py has logic to read/process notes. The db is actually the filesystem :)