asiminaath / interactive-tutorials Goto Github PK

View Code? Open in Web Editor NEW

Interactive Tutorials

License: Apache License 2.0

Python 63.74% CSS 5.88% JavaScript 26.50% HTML 3.83% Dockerfile 0.03% Makefile 0.02%

interactive-tutorials's Introduction

Interactive Tutorials

This is the open source repository for the free interactive tutorial websites:

Please feel free to contribute your tutorials or exercises by sending a pull request and adding yourself on the list.

To run locally, first create a new file called app.env based on app.env.example. (you don't need working credentials to run the website, just to execute code).

Running with Docker

Execute:

DEFAULT_DOMAIN=learnpython.org make run

This command will run learnpython.org website by default using Docker Compose.

To run a specific website, run with the DEFAULT_DOMAIN option set, as follows:

DEFAULT_DOMAIN=learn-js.org make run

By default, the server process will run at http://localhost:5000.

The web server will locally compile and load all Markdown files into memory. The docker needs to be rebuilt upon any change in the Python code or the Markdown code.

Running without Docker (locally)

To run the development server outside of a Docker, run the following command once:

make build-local

And then run:

DEFAULT_DOMAIN=learn-js.org make run-local

IDEOne Credentials

To make the IDEOne execution API work locally, you must obtain a username and password, and add the credentials to a file called app.env. (TBD: add an option to use the remote version)