This Django application runs the Editors' Notes API and authentication server.
Editors' Notes currently uses Python 3.5.
This project depends on the Python package
lxml, which has two dependencies:
libxslt1. They can be installed with your OS's package manager.
- Ubuntu/Debian (aptitude):
apt install libxml2-dev libxslt1-dev
- Fedora/RHEL (dnf):
dnf install libxml2-devel libxslt-devel
- OSX (homebrew):
brew install libxml2 libxslt && brew link libxml2 libxslt
Text in the Editors' Notes API is a superset of the CommonMark markup standard. In order to to render this text into HTML, this application requires a running Editors' Notes Markup Renderer Server. By default, it will look for it on HTTP port 9393.
See editorsnotes/editorsnotes.org for instructions on how to deploy Editors' Notes on a server using nginx and uWSGI.
Local development environment
make setupat the project root directory. This will set up a virtual environment for python packages, install all dependencies, make a skeleton configuration file, and collect all necessary static files.
Edit the skeleton settings file
editorsnotes/settings_local.pywith information about your system. The only setting you must fill out is your database configuration.
make allto execute all database migrations
Make sure that the markup renderer server is running
Start the development server with
./venv/bin/python manage.py runserver