search

alexmojaki / futurecoder

100% free and interactive Python course for beginners
https://futurecoder.io/
MIT License
1.27k stars 132 forks source link
education learning learning-by-doing python

readme

MIT license Tests status logo Testing Powered By SauceLabs

futurecoder

This is a 100% free and interactive course for people to teach themselves programming in Python, especially complete beginners at programming. It is carefully designed to reduce frustration and guide the user while still ensuring that they learn how to solve problems. The goal is for as many people as possible to learn programming.

You can try it out here: https://futurecoder.io/

Please consider contributing or donating!

Alternatively, come have a chat on slack.

Features

For a fuller demonstration and explanation, watch this video.

The course is a fully interactive 'book' which requires the user to run code in the provided editor or shell to advance:
![full](images/full.png)
This requires a mixture of solving problems or simply typing and running provided code. In the latter case, the user is often kept engaged by being asked to predict the output in a simple multiple choice question: The code at each step is checked automatically. If needed, the student can get small hints to gradually guide them to the solution:
![predict_output](images/predict_output.png) ![hints](images/hints.png)
If they're still really stuck, they can reveal the solution bit by bit: Or in some cases solve a *Parsons problem* instead, where they have to put a shuffled solution in the correct order:
![solution](images/solution.png) ![parsons](images/parsons.png)
Tracebacks are more helpful than usual, with several enhancements: - Highlighting the exact operation that failed, not just the line, using [executing](https://github.com/alexmojaki/executing) - Tables of local variables and simple expressions evaluated by [pure_eval](https://github.com/alexmojaki/pure_eval) - Suggestions for fixes provided by [DidYouMean](https://github.com/SylvainDe/DidYouMean-Python) - Beginner friendly explanations provided by [friendly-traceback](https://github.com/aroberge/friendly-traceback) (shown when hovering over the little `i` icon) - Showing multiline statements in full thanks to [stack_data](https://github.com/alexmojaki/stack_data) without showing unnecessary extra lines Common mistakes can be caught and pointed out to the student. This includes specific checks in some steps as well as linting tailored for beginners.
![traceback](images/traceback.png) ![executing](images/messages.png)
Several debuggers are provided, including [snoop](https://github.com/alexmojaki/snoop)... [...birdseye...](https://github.com/alexmojaki/birdseye)
![snoop](images/snoop.png) ![birdseye](images/birdseye.png)
...and [Python Tutor](http://pythontutor.com/)
![pythontutor](images/pythontutor.png)

Running locally

  1. Fork this repo, git clone it, and enter the top-level futurecoder folder.
  2. Install Python 3.11.2 and poetry.
  3. Run poetry install to install Python dependencies.
  4. Run ./scripts/generate.sh. This will generate various static files from Python used by the frontend and run some tests. Repeat this step whenever you change Python files.

  5. In the frontend folder:

    1. Install node. We recommend using version 16.17.1 (lts/gallium) but there are no known issues with other versions.

    2. Run npm ci to download dependencies.

    3. Run npm run build and then copy service-worker.js from the course folder to the public folder. The service worker is used by sync-message to handle time.sleep and reading from stdin (e.g. input()) in Python. If you want to enable caching (not a good idea when developing), set the environment variable REACT_APP_PRECACHE=1 when building.

    4. Run npm start to start the frontend development server.

  6. Go to http://localhost:3000/course/

To learn more about the system, see the contributing guide.

Controls

To explore the course more freely:

  1. Click the hamburger menu icon in the top left.
  2. Click Settings.
  3. Turn Developer mode on.
  4. This should give you two red buttons floating at the bottom of the screen. They change the currently active step, so you can move forward without having to complete exercises or backwards to test a step again.