Skip to content

Repository files navigation

emi

Emi is a period and cycle tracker. Emi stands for Every Month Insights. She pays 29.99 pounds a year. Nobody sells her data, because nobody can read it. The predictions are arithmetic on her own phone. The cloud holds ciphertext and no key.

Emi is not a contraceptive. Emi is not a medical device.

What is here

apps/mobile         the Expo application
packages/tokens     the colours, the type scale and the spacing
packages/cycle      the prediction arithmetic
packages/crypto     the encrypted record format
brand               the logo, the specimen and the generators that draw them
docs                the licences of everything Emi redistributes

Where Emi goes

Version 1 is a part of the product. docs/features.md carries the long term list, which is the whole of it. Each item there says whether version 1 builds it, whether it is planned, or whether it waits on something outside the code.

core cycle tracking     period, flow, ovulation, the fertile window and cycle length
symptoms and health     more than 70 symptoms, and a mode for each condition
medication tracking     doses, injection days, side effects and reminders
sex and relationships   an intimacy log, more than one partner, and a calendar a partner reads
weight                  daily weight, and the trend under the cycle phase
privacy and security    encryption, arithmetic on the phone, export and deletion
insight                 forecasting, patterns across six cycles, and a report for a doctor
arriving here           import, a questionnaire, and a profile built in under five minutes
integrations            the watches, the health platforms, Garmin and Fitbit
notifications           the period, the fertile window, bleeding and medication
content                 guides for each condition, and reports a specialist reads
money                   29.99 pounds a year, and no free tier paid for with her data

How to run it

You need the Node version in .nvmrc. The pipeline reads the same file.

make install
make ios

make iphone runs it on an iPhone plugged in. make android runs it on an Android emulator. make web runs it in a browser.

The gates

make check

It runs what the pipeline runs, in the pipeline order, and it stops at the first failure. Type make on its own for every other command this repository answers to.

A test run that finds no test fails. It does not report success.

The brand sheets

npm run generate:specimen

It draws the type specimen into brand/specimen/specimen.png. It needs a Chromium or Chrome binary, and it looks for one in the usual places. Set EMI_BROWSER to the binary when it cannot find yours.

Licence

MIT. Read LICENCE. The copyright holder is Atlantic Blue Solutions Limited.

The three fonts inside the application are redistributed under the SIL Open Font License, version 1.1. Each family keeps its licence next to its files, and docs/licences.md names all three.

About

Emi: a private period and cycle tracker. Predictions on your phone, an encrypted vault that holds no key.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages