Awesome Open Source
Awesome Open Source

teachcode

A tool to develop and improve a student’s programming skills by introducing the earliest lessons of coding.

Build Status npm version Downloads PRs Welcome code style: prettier Mentioned in Awesome-VuePress Follow on Twitter

Buy Me a Coffee


Chat: Telegram

Donate: PayPal, Patreon

Installation

npm install -g teach-code

How to use

Users are required to solve 30 tasks that take them through the basic constructs of the programming language of their choice. The tasks are designed in such a way that the complexity increases as users progress through the tasks. One can't move forward until the current task is completed. Previously submitted tasks can be viewed if he/she wants but can't be worked on again.

  • teachcode expects you to have a GitHub account. Make sure that you create one if that's not the case.
  • Navigate to the directory of your choice and type in teachcode init.
  • Follow the instructions as prompted.
  • Now type in cd teachcode-solutions.
  • Type in teachcode fetchtask.
  • Hurray 🎉 you've got your first task.
  • Now you can find a config.json and task1.py (language of choice) file within the teachcode-solutions directory.
  • Open up your favourite editor and code up the solution.
  • Now type in teachcode submit.
  • Enter your Git credentials when prompted.
  • Fetch the next task with teachcode fetchtask.

Available Commands

command description
teachcode init Initializes all the tasks
teachcode fetchtask [key] Fetches the task correponding to the key if provided (defaults to the very next task)
teachcode submit Submits the current task
teachcode showkeys Lists all the keys associated with the submitted tasks

Contributing

Contributions of any kind are welcomed. Make sure that you go through these guidelines.

How should I write a commit message?

This project uses Commitlint to check if the commit messages meet the conventional commit format.

The full pattern is:

type(scope?): subject #scope is optional

body? #body is optional

footer? #footer is optional

Following that pattern, your commit messages should look like these:

feat: activate open collective
chore: correct typo

It should be "guest" and not "gest"
refactor(cli): drop support for node 6

BREAKING CHANGE: you will need to update your node version to keep using this CLI
This closes #123

How should I name my branches?

Prefix your branch names with feat/, docs/ or hotfix/ for feature proposals, documentation and bug fixes, respectively.

License

Licensed under GNU General Public License V3.0.


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
javascript (67,340
python (49,780
hacktoberfest (4,243
nodejs (3,568
cli (1,653
python3 (1,468
github (694
hacktoberfest2020 (268
node-js (155
teaching (49

Find Open Source By Browsing 7,000 Topics Across 59 Categories