117 lines
4.2 KiB
Markdown
117 lines
4.2 KiB
Markdown
# Contentmatcher
|
|
|
|
## Development quickstart
|
|
|
|
Create a virtual environment.
|
|
```
|
|
$ python3 -m venv env
|
|
```
|
|
|
|
Activate the virtual environment.
|
|
```
|
|
$ source env/bin/activate
|
|
```
|
|
|
|
Install the required packages.
|
|
```
|
|
$ pip3 install -r requirements.txt
|
|
```
|
|
|
|
Create a database.
|
|
```
|
|
$ mysql
|
|
mysql> create database contentmatcher;
|
|
```
|
|
|
|
Configure the `.env` file with appropriate values.
|
|
```
|
|
$ cp .env.dist .env
|
|
```
|
|
|
|
Run `create_db.py`
|
|
```
|
|
$ python3 create_db.py
|
|
```
|
|
|
|
Run `app.py`.
|
|
|
|
```
|
|
$ python3 app.py
|
|
```
|
|
|
|
## Try it
|
|
Usually there is a running instance [here](https://cm.kompot.si).
|
|
|
|
## About
|
|
Contentmatcher is a [General Intelligence Agency of Ljubljana](https://gia.kompot.si/about.php) prototype.
|
|
|
|
Contentmatcher is hosted by [kompot](https://kompot.si/wiki/doku.php), a librehosters community from Ljubljana.
|
|
|
|
If you have any questions, feedback or if you would like contribute, you can contact us at gia@kompot.si.
|
|
|
|
## Intstructions
|
|
Contentmatcher is a GIA prototype that tries to help you engage with your content and share it with other users. It assumes that you have a heap of content that you would like to reconsider. This heap can take many forms such vast libraries of PDFs on your computer or a long lists of bookmarks.
|
|
|
|
The app will help you get through this content step by step and continue to show you your content again based on the interest you express as well present you with shared content. If you and at least one more person express a high interest in an **item** a match will appear on your matches page. There you can send them an email to talk about the **item** your interested in.
|
|
|
|
### Some definitions:
|
|
* An **item** is a unit of content (like a PDF you upload).
|
|
* **Items** are private by default but they can be shared.
|
|
* A **collection** made up of all your private **items** and the **items** shared with you.
|
|
* When you start a new session Contentmatcher will create a **deck**, which is a small part of the **collection**.
|
|
|
|
### Importing your content
|
|
For now the only way to import content is to upload your PDFs. We're figuring out how to add different lists of links like browser bookmarks, liked tweets and "watch later" youtube videos.
|
|
|
|
### Sessions
|
|
Going through sessions is the main activity in using Contentmatcher. A session consists of rating and potentially shareing **items** in a **deck**. You can adjust the size of your **deck** in the settings. In sessions you rate items with yes, maybe, no and delete buttons. It's weird because there is no question, maybe think of a question like: "Are you really interested in this **item**?"
|
|
|
|
There is also the share button. This will create a new **item** with this content for all other users, so it will appear in their **deck**s from now on as well.
|
|
|
|
### Matches
|
|
If you and at least one other user rate an **item** with a yes then a match will appear on your matches page. There you can send a email to talk.
|
|
|
|
### Feedback
|
|
If you have any questions, feedback, ideas or if you would like contribute, please contact us at gia@kompot.si.
|
|
|
|
## Build instructions
|
|
Comming soon...
|
|
|
|
## TODO
|
|
### Bugs
|
|
#### Critical
|
|
* Arithmetic error, when entering menu
|
|
#### Annoying
|
|
* email adress bug in matches
|
|
* max card is ignored in a session but not in menu
|
|
|
|
### Design issues
|
|
#### Sorting and matching
|
|
* The overlap of this features creates some issues. Interest in terms of sorting is likely lost when an item is read, but it may not be lost in terms of matching.
|
|
* How to remove cards while still wanting to match on them (absolute interest vs match on "yes")
|
|
|
|
### Features
|
|
#### Links
|
|
* cards can be links
|
|
* allow importing of links
|
|
* db representation of link-cards
|
|
* display link in iframe or simmilar
|
|
|
|
#### Algorithm
|
|
* SR-algorithm for decks and appropriate db representation
|
|
* algorithm calculates due cards only with the help of rating history and time of rating.
|
|
* formula for next interval
|
|
* algorithm resets on every 'yes' vote.
|
|
### UI
|
|
* Flash messages should have an approriate color (error is red...)
|
|
* Visual cue to distinguish shared vs private cards
|
|
* PDF action to view more than 10 pages.
|
|
* Fix matches view
|
|
* Email when at least x cards are due, maybe like x = k max_due
|
|
* Keyboard support for all actions
|
|
* scroll PDF
|
|
* links and buttons
|
|
|
|
### Testing
|
|
* there is no testing.
|