meok_log

Meok is an illustrator.

Meok would like to have traces of her progress through posts written in Markdown and datas written at top of the markdowns files.

Currently, the analyzer is in WIP

If you don't know what is a markdown file with yaml meta data, please refer at example of a markdown file format in the Usage section below.

meok_log will read files stored in data directory and :

• split pure markdown contents and yaml-meta datas
• analyze yaml-meta datas datas given a binding config
• serve the results through an API

meok_log use crystal language

Installation

Add this to your application's shard.yml:

dependencies:
  api:
    github: meoklog/meok_log

Usage

Programatically

require "meok_log"

### API

require "src/web/index"

Examples

Markdown:

file: data/my_post.md

---
travail: false
humeur: dépassé par les évènements
stress: 1
date: 2016-10-20
---

- 3ds max

Data directory config:

file : config/data.yml

# Given the markdown files are stored in ./data
data: "./data"

Bindings config:

_note that the "date" property is automatically binded − you can also overrides date binding if wanted _

file : confing/bindings.yml

bindings:
  - humeur
  - stress
  - travail

Development

meok_log is test-driven development using spec2.cr

Some spec2.cr features like context, subject, let are not working at the time writing; some workarounds are needed :

• replace context with describe if you want to use context descriptions,
• put let variables locally, even if it's repeating,
• put subject as subject locally.

Use better specs guidelines when possible.

Tests are located in ./spec directory. To run the tests, type crystal spec in a terminal.

Contributing

1. Fork it ( https://github.com/meoklog/meok_log/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

• meoklog - creator, maintainer