Skip to content

Commit 86fa330

Browse files
committed
add link and screenshot of mockup app
Signed-off-by: Stephen L. <lrq3000@gmail.com>
1 parent 0e48cc8 commit 86fa330

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
(WIP) An easy cross-platfrm logger for daily circadian/periodic events. Stop guessing, start understanding.
66

7+
<p align="center"><img src="docs/circalog-mockup-app-penpot.svg" title="Circalog-mockup-app-penpot" alt="" data-align="center"></p>
8+
79
This app is a generalization of the concept of sleep diary, but instead of recording just sleep periods, it can record any type of event at the simple tap of a button. Events can either be an instant period (eg, drug intake time), or a duration event (eg, sleep period, with a start time and end time, which requires 2 taps). It's also possible to add tags and comments to add additional informations. Databases can be exported as simple csv files, which exports not only the events log but also the configuration (eventtypes).
810

911
Aims for cross-platform support for computers (Windows, Linux, MacOS) and mobile (Android, iOS such as iPhone). Since the app will support automatic merge via unique identifiers of events and eventtypes, it's possible to use the app on multiple devices (eg, Android and Windows) and synchronize the database back and forth by exporting and importing in the app on each device.
@@ -13,3 +15,5 @@ This app is intended for both end-users (patients) and clinicians and research i
1315
The app will be developed with react-native and typescript. Database will likely be stored as SQLite to be cross-platforms compatible.
1416

1517
Circalog sleep diary format specification, intended to be generic to store a maximum of pertinent data for any kind of circadian periodic event, is readable here: https://github.com/Circadiaware/circalog/blob/main/docs/circalog-format-spec.md
18+
19+
A [mock-up app](https://design.penpot.app/#/view/441c1550-c424-11eb-8557-f55ab9adbb41/d0e73e20-e124-11eb-a77a-195c36c76d76?token=42eqNw4QBfdJNSiw-eeueg&index=0) is available on Penpot (the screenshot above is of this mock-up app).

docs/circalog-format-spec.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ The purpose of Circalog is to store any kind of circadian periodic schedule data
66

77
The specification is intended as a working document for now, it is subject to change depending on the needs that arise during software development.
88

9-
The database can be implemented in SQLite. The app should implement a native SQLite <--> CSV import/export function, to natively support not only exports/backups but also imports and merging, if possible the CSV should be a single file to ease exports and backups by non technical users (can easily be sent via e-mail).
9+
The database can be implemented in SQLite. The app should implement a native SQLite <--> CSV or JSON import/export function, to natively support not only exports/backups but also imports and merging using a standard file format that is easy to load for post-processing data analysis, if possible the CSV or JSON should be a single file to ease exports and backups by non technical users (can easily be sent via e-mail).
1010

11-
Draft version: 0.6.2
11+
Draft version: 0.6.3
1212

1313
## SQL relationships diagram
1414

20.8 KB
Loading

0 commit comments

Comments
 (0)