Skip to content

insipidlight/circalog-dev

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 

Repository files navigation

Circalog

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

This app is a generalization of the concept of sleep diaries, 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 point in time (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).

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.

This app is intended for both end-users (patients) and clinicians and research investigators. Indeed, the app can be preconfigured with the event types the investigator would like to monitor. Then, even if there is no logged events, the database can be exported. The investigator can then provide a link to this database through a link online (eg, Dropbox) for the study's participants or patients to import it and preconfigure their app. There's no need to worry if the user already started using the app before, as there is an auto-merge feature which will merge the imported events and eventtypes in while preserving the old ones (each event and eventtypes get a unique identifier - which is meaningless in itself but allows to merge databases).

The app will be developed with react-native and typescript. Database will likely be stored as SQLite to be cross-platforms compatible.

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

An interactive mock-up app is available on Penpot (the screenshot above is of this mock-up app). Please use Chrome based browsers preferably, as there may be an issue with Firefox based browser which makes the text not display correctly, although the mock-up was modified to workaround this issue. On mobiles, the default view may be too small, click on the fullscreen button at the top right corner in the Penpot interface to show the app in almost real size. Backup files for the Penpot project are available in the docs folder.

About

My (scattered) attempt to learn React using this idea

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published