Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Build Status

This is an attempt at building a code editor for beginners who are visually impaired.

Requirements

Quick Start

  1. Create a GitHub app.

  2. Copy .env.sample to .env and fill it out.

  3. Run the following in a terminal session:

    virtualenv venv
    
    # On Windows, replace the following line with 'venv\Scripts\activate'.
    source venv/bin/activate
    
    pip install -r requirements.minimal.txt
    python manage.py runserver
    

Security

Because this app allows users to write arbitrary, unsanitized web content, it needs to be served on a separate (i.e. "sandboxed") domain from the rest of the app.

When running in production with DEBUG set to False, you will need to define the sandboxed and unsandboxed origins using SANDBOXED_ORIGIN and UNSANDBOXED_ORIGIN, respectively. See the Environment Variables section for more details.

Environment Variables

Unlike traditional Django settings, we use environment variables for configuration to be compliant with twelve-factor apps.

You can define environment variables using your environment, or an .env file in the root directory of the repository.

Note: When an environment variable is described as representing a boolean value, if the variable exists with any value (even the empty string), the boolean is true; otherwise, it's false.

  • DEBUG is a boolean value that indicates whether debugging is enabled (this should always be false in production).

  • SECRET_KEY is a large random value corresponding to Django's SECRET_KEY setting. It is automatically set to a known, insecure value when DEBUG is true.

  • DATABASE_URL is the URL for the database, as per the DJ-Database-URL schema.

  • GITHUB_CLIENT_ID is the client ID of your GitHub app.

  • GITHUB_CLIENT_SECRET is the client secret of your GitHub app.

  • SANDBOXED_ORIGIN is the origin on which to serve untrusted user-generated content.

  • UNSANDBOXED_ORIGIN is the origin on which to serve trusted application content.

  • SECURE_PROXY_SSL_HEADER is an optional HTTP request header field name and value indicating that the request is actually secure. For example, Heroku deployments should set this to X-Forwarded-Proto: https.

  • TEST_WITHOUT_MIGRATIONS is a boolean value that indicates whether to disable migrations when running tests.

  • EMAIL_URL is the URL for the email backend. For more details, see the documentation on the email URL schema. When DEBUG is set to true, it defaults to console:.

  • ADMIN_EMAIL is the email address to send error reports to in production. If undefined, error reports will not be emailed.

About

A simple code editor for beginners who are visually impaired.

Resources

Releases

No releases published
You can’t perform that action at this time.