Welcome to Remarq
This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License.
Remarq is a simple Django-powered note-taking platform. Notes are written in Markdown using either a CodeMirror editor or a plain textbox.
Make sure the requirements in
requirements.txt are satisfied. Running
install -r requirements.txt should take care of this. In addition to the
packages specified in
requirements.txt, the following products are
- Python 2.7
- An RDBMS that Django likes (MySQL, Postgres, even Oracle if you're a sadomasochist). Remarq was developed and tested using MySQL, for whatever that's worth.
- MongoDB (either install this yourself or use a service provider like MongoLab, etc.)
- wkhtmltopdf - you need the correct executable for your operating system. Place it somewhere convenient.
Note: Deploying this to Heroku probably works. Or maybe it doesn't.
local_settings.py file in the same directory as
define the following variables:
- Set your database information and Mongo stuff if the
defaults don't work. The default MongoEngine
connect()assumes a server running on
localhostlistening on the default port with no access control (I know, I know). Refer to the relevant MongoEngine docs for information on supplying additional information when connecting to Mongo.
- Set the
TEMPLATE_DIRSvalues as needed. The
TEMPLATE_DIRSpath should just work as defined in
settings.pywithout being changed but
STATIC_URLwill need to be changed in pretty much every case.
WKHTMLTOPDF_PATHto the location where you extracted
After the requirements are in place and
settings.py has been appropriately
modified, run the following commands from within the
manage.py syncdb- This will also ask you to create an admin user, be sure to do so.
manage.py migrateto take care of the South migrations.
After configuration, you will need to set up your web server and (probably) WSGI interface. Nginx and Gunicorn seem to work well.