childsafe.io

No-code, easy configuration media scanning for cloud storage to keep children safe.

Powered by Django and Celery.

Table of Contents

• Installation
• Development
• Meta

Installation

Install this Django application by first cloning the repository.

git clone https://github.com/RobSpectre/childsafe.io

Install the Python dependencies.

cd garfield
pip install -r requirements.txt

Create a local configuration file and customize with your settings.

cd childsafe.io/childsafe/childsafe
cp local.sample local.py

Create database.

cd ..
python manage.py makemigrations
python manage.py migrate

Run the server

python manage.py runserver

Development

Hacking

Install RabbitMQ, required for the Celery task queue. Instructions for Ubuntu.

$ sudo apt-get update
$ sudo apt-get install rabbitmq-server

To hack on the project, fork the repo and then clone locally.

$ git clone https://github.com/RobSpectre/childsafe.io.git

Move to the project directory.

$ cd childsafe

Install the Python dependencies (preferably in a virtualenv).

$ pip install -r requirements.txt

Then customize your local variables to configure your external dependencies.

$ cp childsafe.io/childsafe/local.sample childsafe/childsafe/local.py
$ vim childsafe/childsafe/local.py

Move to the Django project root.

$ cd garfield

Start the Celery task queue.

$ celery -A garfield worker -l info

Start the Django app.

$ python manage.py runserver

Testing

Use Tox for easily running the test suite.

$ tox

Meta

• Created by Eddie Zaneski, Greg Baugues, Ricky Robinett, and Rob Spectre
• Released under MIT License
• Software is as is - no warranty expressed or implied.