PKU Limitter

---

Opensource mobile app for counting PHE/protein for Phenylketonuria.

📝 Table of Contents

• About
• Prerequisites
• Getting Started
• Tests
• TODO
• Build using
• Authors

🧐 About

My personal project, it is mostly for my need counting daily PHE/protein (protein for simlification). I am still working on this project, in close tim I want to release mobile apps to stores. You can see all planned features in TODO section If you are interested in contributting, just create pull request with your change and I will get to that.

🔎 Prerequisites

Not nessesary minimum requirements, but I am using this versions

node => 16.9.1
yarn => 1.22.17

For mobile development you need install native development apps:

iOS: Xcode Android: Android Studio

🏁 Getting Started

First you need to install all the dependencies

yarn

after all is installed, you can run local server

yarn start

For deveoplment on phone (emulator) please follow the instructions on ionicframework documentation: iOS, Android.

🔧 Tests

There are simple Cypress tests for basic functionality. You can run them by command

yarn cypress:headless

And to modify and add new tests just run the following command

yarn cypress

I am planing to add cypress tests to github actions - for now it is in TODO

📋 TODO

• PDF exports
• Week statistics
• Release Android Application
• Release iOS Application
• Finish implementing eslint
• Cypress Github actions
• ✅ Cypress tests

⛏️ Built Using

• Ionic Framework - For building native apps and UI
• ReactJS - Web Framework
• Cypress - End to end testing framework (in development TODO)

✍️ Authors

• @pavelsima - Idea & Initial work