memex/README.md
2018-07-24 00:37:55 +12:00

49 lines
1.4 KiB
Markdown

**Memex** is a simple open-source bookmarks and notes application to help with storage and overview
[Live web version here](https://kormyen.github.io/memex/)
<img src='https://raw.githubusercontent.com/kormyen/memex/master/PREVIEW.jpg' width="600"/>
Memex has two modes:
- standalone application for bookmark and note cataloging
- read-only static 'sever-less' website for sharing with sorting and filtering
Memex supports:
- links
- images
- notes
- quotes
- terms
- tags
- filtering
#### Data
Data is stored in a human-readable, flat-file database called [Indental](https://wiki.xxiivv.com/#indental) which is made by Devine Lu Linvega
- [docs/content/data.ndtl](docs/content/data.ndtl)
#### Development
```
git clone git@github.com:kormyen/memex.git
cd memex
npm install
npm start
```
#### Dependencies
- App builder: [Electron](https://electronjs.org/)
- Database parser: [Indental](https://wiki.xxiivv.com/#indental)
- Template parser: [Runic](https://wiki.xxiivv.com/#runic)
- Grid layout: [Masonry](https://masonry.desandro.com/)
Thanks to Devine Lu Linvega ([Oscean](https://github.com/XXIIVV/Oscean)), Josh Avanier ([Log](https://github.com/joshavanier/log)), Rekka Bell ([kokorobot](https://github.com/rekkabell/kokorobot)) and Alexey Botkov ([Legacy](https://github.com/nomand/Legacy))
---
Hamish MacDonald
**[Twitter](https://twitter.com/kormyen)** &middot; **[Home](https://kor.nz)**