README.md

Sophify

A command line tool for assembling education curricula

soph: from the greek Sophia meaning wisdom and ify: "to make or cause to become"

Sophify is a tool to help educators assemble small, independent pieces of curriculum into a course just as developers build apps by assembling many libraries.

This app is under early development and not ready for use.

Terminology

• segment: an individual piece of curriculum. Each segment is a standalone node module
• course: a programme of learning built on top of multiple segments

Intended usage

sophify init [type] #create a sophify.json file and setup initial folder structures - type defaults to course
sophify build #build all the curriculum
sophify add [segment-name] #add a new segment to the course (wraps npm install)
sophify remove [segment-name] #remove a segment from the course (wraps npm uninstall)

A segment can recursively build on top of other segments. From a students point of view a segment is an internal component that they don't see and they think about their learning in terms of courses.

Key tech

• gitbook for managing student and teaching guides
• revealjs for slides

Folder structure

./segments/ #a segments
./student-guide/ #gitbook for student facing materials
./teaching-guide/ #gitbook for teacher facing materials
./slides/ #slide decks for the segments

sophify.json

for a segment

{
  "sophify-type": "segment"
}

for a course

{
  "sophify-type": "course",
  "pre-requisites": {
    "other-course": "https://github.com/enspiral-dev-academy/other-course"
  },
  "further-study": {
    "harder-course": "https://github.com/enspiral-dev-academy/harder-course"
  }
}