This is an attempt at building a code editor for beginners who are visually impaired.
- Python 3.5
Create a GitHub app.
.envand fill it out.
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
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
UNSANDBOXED_ORIGIN, respectively. See the Environment Variables
section for more details.
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
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.
DEBUGis a boolean value that indicates whether debugging is enabled (this should always be false in production).
SECRET_KEYis a large random value corresponding to Django's
SECRET_KEYsetting. It is automatically set to a known, insecure value when
DATABASE_URLis the URL for the database, as per the DJ-Database-URL schema.
GITHUB_CLIENT_IDis the client ID of your GitHub app.
GITHUB_CLIENT_SECRETis the client secret of your GitHub app.
SANDBOXED_ORIGINis the origin on which to serve untrusted user-generated content.
UNSANDBOXED_ORIGINis the origin on which to serve trusted application content.
SECURE_PROXY_SSL_HEADERis an optional HTTP request header field name and value indicating that the request is actually secure. For example, Heroku deployments should set this to
TEST_WITHOUT_MIGRATIONSis a boolean value that indicates whether to disable migrations when running tests.
EMAIL_URLis the URL for the email backend. For more details, see the documentation on the email URL schema. When
DEBUGis set to true, it defaults to
ADMIN_EMAILis the email address to send error reports to in production. If undefined, error reports will not be emailed.