An open API service indexing awesome lists of open source software.

https://github.com/srid/modus

WIP: Plain text files for life
https://github.com/srid/modus

haskell obelisk plain-text reflex

Last synced: 4 months ago
JSON representation

WIP: Plain text files for life

Awesome Lists containing this project

README

        

# modus

Text is the format for life to store our notes and information. Modus provides
the functionality needed to process and view them in structured manner. Keep
your data as plain text files, without compromising on functionality.

## Architecture

This is a single-page web app written in Haskell using Obelisk (Reflex FRP).

A text file may be of different formats, ranging from good ol' markdown to any
arbitrary structured format. You can use, for example, YAML to record some data,
or design your own format for it. In Modus there will be a parser for each of
these types, and a renderer that displays them on the frontend. Writing and
editing content, however, is outside the scope of modus; you are adviced to use
your own text editor for that.

## Plugins

- [X] Time Tracker
- [ ] Task visualizer
- [ ] Seinfeld calendar

## How to run modus locally

1. [Install obelisk](https://github.com/obsidiansystems/obelisk#installing-obelisk)
2. echo `/path/to/your/directory/of/text/files` > config/backend/data-directory
2. Run `ob run`