|
|
@ -4,9 +4,18 @@ The Store is the central point of the application. It is responsible for |
|
|
|
keeping all the information sent by Capturers and providing a search/list |
|
|
|
keeping all the information sent by Capturers and providing a search/list |
|
|
|
functionality for Viewers. |
|
|
|
functionality for Viewers. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Configuration |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
We would need, at least (probably in envvars): |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- `IP`: Binding IP for the server. |
|
|
|
|
|
|
|
- `PORT`: Binding port for the server. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Internals |
|
|
|
|
|
|
|
|
|
|
|
We would probably need a design like: |
|
|
|
We would probably need a design like: |
|
|
|
|
|
|
|
|
|
|
|
## Entry |
|
|
|
### Entry |
|
|
|
|
|
|
|
|
|
|
|
| Field | Description | |
|
|
|
| Field | Description | |
|
|
|
| ------- | --------------------------------------------------- | |
|
|
|
| ------- | --------------------------------------------------- | |
|
|
@ -15,7 +24,7 @@ We would probably need a design like: |
|
|
|
| content | Text, produced by a Capturer. It's always Markdown. | |
|
|
|
| content | Text, produced by a Capturer. It's always Markdown. | |
|
|
|
| source | Capturer name. | |
|
|
|
| source | Capturer name. | |
|
|
|
|
|
|
|
|
|
|
|
## Meta |
|
|
|
### Meta |
|
|
|
|
|
|
|
|
|
|
|
Meta contains the meta information of the entry, used by a Capturer. A view may |
|
|
|
Meta contains the meta information of the entry, used by a Capturer. A view may |
|
|
|
or may not display those fields. |
|
|
|
or may not display those fields. |
|
|
@ -27,14 +36,14 @@ or may not display those fields. |
|
|
|
| name | Meta field name. | |
|
|
|
| name | Meta field name. | |
|
|
|
| value | Meta field value. | |
|
|
|
| value | Meta field value. | |
|
|
|
|
|
|
|
|
|
|
|
## Attachments |
|
|
|
### Attachments |
|
|
|
|
|
|
|
|
|
|
|
Attachments are not meta information, but something related to the entry -- for |
|
|
|
Attachments are not meta information, but something related to the entry -- for |
|
|
|
example, if the content contains any images, those are added as attachments. |
|
|
|
example, if the content contains any images, those are added as attachments. |
|
|
|
|
|
|
|
|
|
|
|
| Field | Description | |
|
|
|
| Field | Description | |
|
|
|
| ------------ | --------------------------------------------------- | |
|
|
|
| ------------- | --------------------------------------------------- | |
|
|
|
| id | UUID of the record. | |
|
|
|
| id | UUID of the record. | |
|
|
|
| entry | ForeignKey of the entry. | |
|
|
|
| entry | ForeignKey of the entry. | |
|
|
|
| content_type | Type of the content. | |
|
|
|
| content\_type | Type of the content. | |
|
|
|
| content | Attachment content, in Base64. | |
|
|
|
| content | Attachment content, in Base64. | |
|
|
|