memex/README.md

49 lines
1.4 KiB
Markdown
Raw Normal View History

2018-07-23 12:37:55 +00:00
**Memex** is a simple open-source bookmarks and notes application to help with storage and overview
2018-07-13 15:56:09 +00:00
2018-07-21 11:23:06 +00:00
[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
2018-07-22 20:13:13 +00:00
- read-only static 'sever-less' website for sharing with sorting and filtering
2018-07-21 11:23:06 +00:00
Memex supports:
- links
- images
- notes
- quotes
- terms
2018-07-22 20:13:13 +00:00
- tags
2018-07-23 12:37:55 +00:00
- filtering
2018-07-17 21:04:33 +00:00
2018-07-23 12:37:55 +00:00
#### Data
2018-07-22 20:31:38 +00:00
Data is stored in a human-readable, flat-file database called [Indental](https://wiki.xxiivv.com/#indental) which is made by Devine Lu Linvega
2018-07-21 11:23:06 +00:00
2018-07-22 20:13:13 +00:00
- [docs/content/data.ndtl](docs/content/data.ndtl)
2018-07-13 15:56:09 +00:00
2018-07-23 12:37:55 +00:00
#### Development
```
git clone git@github.com:kormyen/memex.git
cd memex
npm install
npm start
```
#### Dependencies
2018-07-13 15:56:09 +00:00
2018-07-21 11:39:40 +00:00
- App builder: [Electron](https://electronjs.org/)
- Database parser: [Indental](https://wiki.xxiivv.com/#indental)
- Template parser: [Runic](https://wiki.xxiivv.com/#runic)
2018-07-22 20:31:38 +00:00
- Grid layout: [Masonry](https://masonry.desandro.com/)
2018-08-05 15:04:44 +00:00
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)), Alexey Botkov ([Legacy](https://github.com/nomand/Legacy)), Seena Burns ([Isolate](https://github.com/seenaburns/isolate))
2018-07-23 12:37:55 +00:00
---
Hamish MacDonald
**[Twitter](https://twitter.com/kormyen)** &middot; **[Home](https://kor.nz)**