https://github.com/byron/rust-hack-and-learn

A web-app for managing Katas for Rust
https://github.com/byron/rust-hack-and-learn

Last synced: 5 months ago
JSON representation

A web-app for managing Katas for Rust

• Host: GitHub
• URL: https://github.com/byron/rust-hack-and-learn
• Owner: Byron
• Created: 2015-10-17T11:33:29.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2016-10-06T07:09:49.000Z (over 9 years ago)
• Last Synced: 2025-05-29T17:49:11.270Z (about 1 year ago)
• Language: JavaScript
• Homepage: http://byron.github.io/rust-hack-and-learn
• Size: 4.46 MB
• Stars: 2
• Watchers: 2
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
A simple web-app to assure one can exercise Rust katas even *without internet*. You can host it by running `make`, open an ad-hoc network and direct the students to your IP/hostname.

![screen](https://raw.githubusercontent.com/Byron/rust-hack-and-learn/master/screen01.png)

It provides:

* a curated list of Katas

* a pairing guide (in case you want to learn together)

* Rust installers (not included in repository)

## How to add a new Kata

* open the [Katas.js][] service file and add meta-data for your new kata.

  - use the existing ones as example

  - don't forget to set the `originalSource` field in case the Kata is copied from elsewhere. Otherwise the field may remain unset.

* place a markdown description file into [`resources/katas//description.md`][res-katas]

* optionally place all example files into `resources/katas//examples` and add their filenames to the `example.files` array of the kata's meta-data object`.

* *if not done already, run `grunt serve` to test your changes*

## Initial Setup

Run `npm update && bower update` in the project directory.

Additionally, you will need:

* `compass` for transpiling `sass` to `css`

 - `sudo gem install compass` should do the job.

## Build & development

[![Build Status](https://travis-ci.org/Byron/rust-hack-and-learn.svg?branch=master)](https://travis-ci.org/Byron/rust-hack-and-learn)

Run `grunt` for building and `grunt serve` for preview.

## Testing

Running `grunt test` will run the unit tests with karma.

[Katas.js]: https://github.com/Byron/rust-hack-and-learn/blob/master/app/scripts/services/katas.js#L9

[res-katas]: https://github.com/Byron/rust-hack-and-learn/tree/master/app/resources/katas