https://github.com/steve-1820/memex
A brief POC of what a Memex could potentially be.
https://github.com/steve-1820/memex
Last synced: 4 months ago
JSON representation
A brief POC of what a Memex could potentially be.
- Host: GitHub
- URL: https://github.com/steve-1820/memex
- Owner: steve-1820
- License: mit
- Created: 2020-08-31T10:59:52.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-10-12T09:59:21.000Z (over 4 years ago)
- Last Synced: 2024-08-13T07:18:12.555Z (8 months ago)
- Language: TypeScript
- Size: 3.21 MB
- Stars: 178
- Watchers: 7
- Forks: 15
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - steve-1820/memex - A brief POC of what a Memex could potentially be. (TypeScript)
README
## Intro
This a POC on how a memex could potentially work.
## Demo
Streaming data from browser to Electron app: https://vimeo.com/456346417
Knowledge map for notes discovery: https://vimeo.com/455978016
Rich text editor to write notes: https://vimeo.com/456732222
## Motivation
Read the full blog article here: https://www.steveliu.co/memex
## Install
First, clone the repo via git and install dependencies:
```bash
git clone https://github.com/steve-1820/memex.git
cd memex
yarn
```
## Starting Development
NOTE: Please first clone and run the companion Chrome Extension (https://github.com/steve-1820/memex-chrome-extension) so that your user behaviour (i.e blogs you read etc and highlights) are streamed to the Electron app.
Start the app in the `dev` environment. This starts the renderer process in [**hot-module-replacement**](https://webpack.js.org/guides/hmr-react/) mode and starts a webpack dev server that sends hot updates to the renderer process:
```bash
yarn dev
```
## Packaging for Production
To package apps for the local platform:
```bash
yarn package
```
## License
MIT Licence