https://github.com/evuez/iruka

https://github.com/evuez/iruka

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/evuez/iruka
• Owner: evuez
• License: bsd-3-clause
• Created: 2020-03-17T13:15:17.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T16:08:55.000Z (over 1 year ago)
• Last Synced: 2023-08-01T10:12:39.017Z (about 1 year ago)
• Language: Elm
• Size: 811 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# iruka

A file format for flashcards accompanied with a parser and a small web application.

## File format

## Parser

The parser lives in `src/` and `app/`, and can be installed using `make install` (you'll need to install [`stack`](https://docs.haskellstack.org/en/stable/install_and_upgrade/) first).

For now, it only outputs JSON because that's what the web application is using, run `iruka cards.iruka cards.json` to generate a JSON file from an `iruka` file.

## Application

An Elm application, everything related to it is in `web/`.

If you have [`yarn`](https://docs.haskellstack.org/en/stable/install_and_upgrade/) installed, it should be as easy as running `make start` to start the local dev server.

---

## Formatting

```

make format

```

## Running the tests

```

make test

```

or

```

make test.watch

```