https://github.com/ilmanzo/crystal-koans

The Crystal Programming Language Koans
https://github.com/ilmanzo/crystal-koans

crystal hacktoberfest koans test-suite

Last synced: 3 months ago
JSON representation

The Crystal Programming Language Koans

• Host: GitHub
• URL: https://github.com/ilmanzo/crystal-koans
• Owner: ilmanzo
• License: mit
• Created: 2017-02-13T14:24:31.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-11-02T17:40:04.000Z (3 months ago)
• Last Synced: 2024-11-02T18:27:36.111Z (3 months ago)
• Topics: crystal, hacktoberfest, koans, test-suite
• Language: Crystal
• Homepage:
• Size: 88.9 KB
• Stars: 48
• Watchers: 4
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-crystal - crystal-koans - Learn Crystal by writing unit tests (Unofficial)

README

        
# The Crystal Language Koans

Inspired from RubyKoans, CppKoans, GoKoans; an educational unit test suite for

the [Crystal Programming Language](https://crystal-lang.org/) and standard library.

## Installation

- clone this repository: `git clone "https://github.com/ilmanzo/crystal-koans"`

## Manual Usage

1. run `crystal run koans.cr` to make a small step at a time 

   or run `crystal spec` to run all the tests at once

2. observe the test errors

3. think and make the test pass

4. goto step 1

## Automatic Usage (run tests on save)

1. install shard dependencies with `shards install`

2. open a separate terminal and run `crystal run watch.cr`. Keep it open and visible

3. observe the test errors, think and make the test pass

4. tests will automatically run as you save the files. Press CTRL-C to stop the watcher

## Contributing

1. Fork it ( https://github.com/ilmanzo/crystal-koans/fork )

2. Create your feature branch (git checkout -b my-new-feature)

3. Commit your changes (git commit -am 'Add some feature')

4. Push to the branch (git push origin my-new-feature)

5. Create a new Pull Request

## Contributors

- [ilmanzo](https://github.com/ilmanzo) Andrea Manzini - creator, maintainer

- [Daniel Sokil](https://github.com/s0kil)

- [Dorian Marié](https://github.com/dorianmariefr)

- [Jack Kavanagh](https://github.com/jackkav)

- [collidedscope](https://github.com/collidedscope)