Skip to content

Latest commit

 

History

History
92 lines (63 loc) · 2.45 KB

README.rst

File metadata and controls

92 lines (63 loc) · 2.45 KB
Raw

The Kremlin Magical Everything System

The Magical Everything System does Everything.

https://travis-ci.org/glasnost/kremlin.svg?branch=master

Features:

  • Image Board
  • Boredom Inhibitor
  • Science Experiment
  • Operating System Overview
  • Arguably alive

!DANGER!

May contain traces of Knifacode(tm)

Requirements:

These are the requirements for running the application. Unless you are sitting there reading this from a tagged release archive, it probably will not be entirely accurate.

  • Python 3

  • Python 3 venv is strongly recommended

  • For production deployment, a decent web server supporting WSGI

    -- or--

  • gunicorn behind something like nginx.

Python Modules:

  • Flask - Amazing Python Microframework Extraordinaire
  • Jinja2 - Templating Engine
  • Pillow (recommended) _or_ PIL - Image manipulation library
  • SQLAlchemy - Declarative ORM
  • WTForms - Web form helper/library

Flask Modules:

Note

Being a microframework, it doesn't do much.

  • Flask-SQLAlchemy
  • Flask-Uploads
  • Flask-WTF

Very Hastily Written™ Hacker's Guide to Poking at the Source

  1. $ python3 -m venv --clear .env
  2. $ source .env/bin/activate
  3. (kremlin)$ pip install -r requirements.txt
  4. (kremlin)$ git clone https://github.com/glasnost/kremlin.git kremlin
  5. (kremlin)$ cd kremlin
  6. (kremlin)$ cp kremlin-example.cfg kremlin.cfg && vim kremlin.cfg
  7. (kremlin)$ KREMLIN_CONFIGURATION=$(pwd)/kremlin.cfg python runserver.py

Note

On Mac OS X you will need additional dependencies before Pillow builds correctly.

Run this before you run pip install above:

brew install libjpeg

You will of course need Brew installed.