<h1id="overview"class="page-header">Overview</h1>

CodeRoad aims to make building & sharing interactive tutorials as easy as possible.

CodeRoad aims to make building & sharing interactivecodingtutorials as easy as possible.

<divclass="lead">We hope to create fun and maintainablecoding tutorials that actually improve with time. We hope to see students become teachers, teachers become empowered, and coders become better, faster. But first, let's get some interactive tutorials built.

That's where you come in.</div>

<divclass="lead">We hope to create fun and maintainablecode tutorials that actually improve with time. We hope to seeprogrammingstudents become teachers, teachers become empowered, and coders become better, faster. But first, let's get some interactive coding tutorials built.

That's where you come in.</div>

<ahref="/build"class="btn btn-default btn-lg"><iclass="fa fa-road fa-fw"></i><spanclass="network-name">Read an Overview of Building a Tutorial</span></a>

*@hint* loads a string(or array of strings)which can be used to provide hints for the user. The order of hints is important: first in, first out.

*@hint* loads a string which can be used to provide hints for the user. The order of hints is important: first in, first out.

@hint('A hint for the user')

@hint(['Hint 1', 'Hint 2'])

*@hint* may use code-blocks with syntax highlighting, but they must be wrapped in quotes.

More editor actions will be added to CodeRoad at a later date.

More editor actions will be added to CodeRoad at a later date. These may include changing the cursor position, replacing content, decorating keywords, etc.

file:2016-01-06-loaders.md

Tutorials may be written in different programming languages or for different compilers, so there isn't yet a standard way to load data from user created files. Instead, you'll have to load yourown solution into your tutorial and link to them from yourtestfile. Rolling your own solution allows you to load data in a way that fits your project.

Tutorials may be written in different programming languages or for different compilers, so there isn't yet a standard way to load data from user created files. Instead, you'll have to load/transpile yourfiles for thetestrunner. Rolling your own solution allows you to load data in a way that fits your project.

These snippets should help:

There may be a simpler approach in the future, but for now these snippets should help:

}

This section will likely expand in the future. For now, let's go over some ofthese.

This section will likely expand in the future. For now, let's go over some ofthe configurations.

id:test-runners

file:2016-01-10-test-runner.md

A test runner works by creating a child process and calling a test framework with target files.

ACodeRoadtest runner works by creating a child process and calling a test framework with target files, then returning the result as a JSON object.

In this way, the test runner not only determines how unit tests will be written, but it actually determines the programming language used in the tutorial.

If you're interested in helping CodeRoad support a programming language of your choice, here's how to set up the test runner.

If you're interested in helping CodeRoad support adifferentprogramming language or test framework of your choice, here's how to set up the test runner.

The test runner should spawn a child process. Think of this like your program opening up a terminal, typing in command line commands, then collecting and returning the the results to*Atom-CodeRoad*. See[an example child process createdin*mocha-coderoad*](https://github.com/coderoad/mocha-coderoad/blob/master/src/create-runner.ts).

The test runner should spawn a child process. Think of this like your program opening up a terminal, typing insomecommand line commands to run tests, then collecting and returning the the results to*Atom-CodeRoad*. See[an example child process createdinside of Atom for*mocha-coderoad*](https://github.com/coderoad/mocha-coderoad/blob/master/src/create-runner.ts).

The test runner is called with four ordered inputs, two of which act as callback functions that return the log& result to*Atom-CodeRoad*.

The test runner is calledin*Atom-CodeRoad*with four ordered inputs, two of which act as callback functions that return the logor result.

See a brief example from the[*mocha-coderoad* runner](https://github.com/coderoad/mocha-coderoad/blob/master/src/runner.ts).

See a brief example from the[*mocha-coderoad* runner](https://github.com/coderoad/mocha-coderoad/blob/master/src/runner.ts), as well as a code summary below:

exportdefaultfunctionrunner(testFile,config,handleResult,handleLog) {

}

Let's look at these four inputs in more detail.

Let's look at these fourtest runnerinputs in more detail.

The absolute path to a file containing all concatenated page tests. Call your test framework with this.

The absolute path to a file containing all concatenated page tests. Call your test framework with this file path.

A JSON object of configurations, seean example below

A JSON object of configurations that may be needed for setting up your runner. Seean example below:

{

A callback function that should be called with the**result** object. Results should either pass if all pass, or fail if any test fails.

A callback function that should be called with the**result** object. Results should pass if all tests pass, or fail if even a single test fails.

The result should output the*taskPosition* after the test. The field*change* represents the difference between the starting 'taskPosition' and the resulting 'taskPosition'.

}

The result should output the 'taskPosition' after the test. 'change' represents the difference between the starting 'taskPosition' and the resulting 'taskPosition'.

A callback function that shouldbe called with a string**log** statement

A callback function that shouldreturn the output**log** statement.

*If you need help setting up a new test runner, please send an email tocoderoadapp@gmail.com.*