a Django-based indieweb.org site https://00dani.me/
Danielle McLean aace340503 1.9.9 2 months ago
entries Throw out support for AMP, because AMP sucks anyway 2 months ago
home Nicely handle the unlikely case where the h-card contains absolutely no PGP keys and/or social profiles 3 months ago
lemonauth Throw away now-unused lemonauth templates, since they've all been ported across to Jinja2 2 months ago
lemoncurry Throw out support for AMP, because AMP sucks anyway 2 months ago
lemonshort Install mypy and make the minimum changes necessary for it to pass, albeit using --ignore-missing-imports 2 months ago
micropub Add a Link header to the Micropub create response indicating the entry's shortlink 3 months ago
users Add caching and smarter resizing to the Libravatar endpoint 2 months ago
webmention Add docstring to webmention:status endpoint 3 months ago
wellknowns Replace the previous WebFinger implementation with a fairly simple forwarder to Bridgy Fed, so that Bridgy Fed will work eventually 3 months ago
.gitignore Install mypy and make the minimum changes necessary for it to pass, albeit using --ignore-missing-imports 2 months ago
.gitlab-ci.yml Simplify the GitLab cache config, should be more reliable this way? 2 months ago
.gitmodules Load the Material colour scheme directly from the source YAML, rather than hardcoding it into Stylus format 9 months ago
.pre-commit-config.yaml Add pytest and mypy steps to the pre-commit hooks to avoid committing clearly broken code 2 months ago
.pyup.yml Configure pyup to look at my Pipfiles 3 months ago
.travis.yml Explicitly mark the environment variables as global 2 months ago
Forwardfile Add a Forwardfile for development 9 months ago
LICENSE Extend the copyright range in the license to cover 2018 as well 5 months ago
Pipfile Install mypy and make the minimum changes necessary for it to pass, albeit using --ignore-missing-imports 2 months ago
Pipfile.lock Bump library versions using pipenv lock 2 months ago
README.md Fix bad indent and a few actual errors in README.md 2 months ago
lemoncurry.paw Create a basic but functional micropub media endpoint :o 3 months ago
lemoncurry.svg Add the lemoncurry logo - yes, it's just FA's lemon layered over a dark circle 5 months ago
manage.py Make development-specific settings file 9 months ago
package.json 1.9.9 2 months ago
pytest.ini Add support for tests that use django.test.Client and that require a database, and use this support to test some of the wellknowns.views modules 6 months ago
yarn.lock Bump npm library versions using yarn upgrade 2 months ago

README.md

lemoncurry (always all-lowercase) is a Django-based personal site designed to operate as part of the IndieWeb. It currently supports the following IndieWeb specifications natively.

  • All content is exposed using standard microformats2 markup, making it easy for other sites and applications across the IndieWeb to consume.
  • Additionally, the site owner’s profiles are exposed using rel-me, enabling independent verification of their identity across various services. This permits IndieAuth.com to authenticate the site’s owner using a social profile, such as a Twitter account. However, this functionality is not necessary because lemoncurry also fully implements…
  • IndieAuth, an protocol derived from OAuth 2.0 which enables the site’s owner to authorise access to their domain directly from the lemoncurry site itself. Additionally, tokens for further access to the lemoncurry site may be requested and issued, including customisable token scope as in OAuth.
  • Micropub is partially supported - using a token obtained through IndieAuth, clients may post new content to the lemoncurry site using either the form-encoded or JSON request formats. There is currently no support for updating or deleting existing content through Micropub, although this is of course planned.
  • Webmention, used to enable rich commenting and social interaction between separate IndieWeb sites, is partially supported. lemoncurry will correctly send webmentions to all URLs mentioned in a published entry. However, it currently does not expose an endpoint for receiving webmentions.
  • WebSub is also partially supported. When content is posted through Micropub, WebSub is pinged as it should be - however, since only creating new content through Micropub is supported, updates do not currently cause a WebSub ping.

Requirements

lemoncurry uses the following tools:

  • Pipenv - developed with Pipenv 2018.5.18, but should work with most versions.
  • Yarn - again, developed with Yarn 1.7.0, but should work with most versions.

As well as the following services:

  • PostgreSQL - create a database named lemoncurry. Socket auth is recommended, so ensure the UNIX user you’ll be running lemoncurry with has access to that database. Alternatively, set the POSTGRES_PASSWORD environment variable to use password auth.
  • Redis - lemoncurry expects to find Redis on port 6380, rather than the standard port of 6379. Sorry about that.

If you’re running in production, I’d recommend Gunicorn, which is already part of lemoncurry’s Pipfile. Ensure you run Gunicorn behind a secure reverse proxy, such as Nginx.

If you’re running in development, the usual Django runserver command should be fine.

Installation

Clone the repo recursively - since it uses Git submodules - and then install both Python and Node dependencies.

$ git clone --recursive https://git.00dani.me/00dani/lemoncurry
$ cd lemoncurry
$ pipenv install --dev
$ yarn install

Once those steps complete, you should be able to perform the usual Django steps to get a development server up and running. (If you’d prefer, you can use pipenv shell to activate lemoncurry’s virtualenv, rather than prefacing each command with pipenv run. I like being explicit.)

$ pipenv run ./manage.py migrate
$ pipenv run ./manage.py collectstatic
$ pipenv run ./manage.py runserver 3000