https://github.com/objarni/private-tutor-helper

Simple web app to help journalling lessons given while doing private tutoring
https://github.com/objarni/private-tutor-helper

Last synced: 8 months ago
JSON representation

Simple web app to help journalling lessons given while doing private tutoring

• Host: GitHub
• URL: https://github.com/objarni/private-tutor-helper
• Owner: objarni
• License: mit
• Created: 2019-12-16T12:14:57.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-01T16:29:49.000Z (about 2 years ago)
• Last Synced: 2025-09-07T20:57:23.262Z (9 months ago)
• Language: Python
• Size: 195 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# private-tutor-helper

Simple web app to help journalling lessons given while doing private tutoring.

## Why?

I needed a way to keep track of what lessons I had given, e.g. their content, what "homework" I suggested, and what hurdles were observed, as a reminder to myself for the next lesson.

The previous iteration of this system was a single `journal.json` file structured so that I could easily add entries (and read previous entries). An example of the content would be:

```

{

  "Pupils": {

    "Bill Klinton": {

      "Title": "CEO Digital Soft",

      "Email": "bill@klingon.net",

      "Journal": {

        "2019-12-01": {

          "Location": "At his home",

          "ThisFocus": "PyCharm+requests installation and testing AB/CD API",

          "Homework": "Finish script",

          "NextFocus": "String formatting"

        },

        "2019-12-15": {

          "Location": "At his home",

          "ThisFocus": "String formatting, especially f-strings",

          "Homework": "Rewrite string formatting code of script to use f-strings",

          "NextFocus": "Logging"

        }

      }

    }

  }

}

```

### How do I setup development environment?

Install elm:

    npm install -g elm

Also make sure Python3.6+ is available.

### How do I build the app?

    ./build.sh

### How do I run the app?

    ./run.sh

.. then surf to http://localhost:8000/index.html to view and update journal.

### What is the tech stack?

  - Elm0.19 + elm-ui for front end

  - Python3.6 with bottle.py for backend

  - git + GitHub for hosting, version control

  - Bash scripts for build, running

### TODO

  - introduce elm-test to project (investigate how this is installed properly in 19.1 nowadays)

  - introduce elm-program-test for regression testing