lenaschimmel / riskjournal-cli

A command line client to manually track the risk of contracting COVID-19 during various activities.

RiskJournal CLI

This is part of a multi-repository project. See the riskjournal repository for a general overview.

A command line client to log activities and their risk of contracting COVID-19.

Heavily inspired and based on the the great microCOVID.

Table of Contents

• RiskJournal CLI
  • Table of Contents
  • About The Project
  • Getting Started
    • Prerequisites
    • Installation
  • Usage
  • Roadmap
  • Contributing
  • License
  • Contact
  • Acknowledgements

About The Project

This product is in very early development and SHOULD NOT BE USED YET.

If you are looking for a project that is reliable and ready to be used, head over to microcovid.org (source on GitHub).

In the near future, this app will let you keep a local journal of every activity that has some risk of contracting COVID-19 and compute your accumulated risk.

I'm currently building a command line interface because that's the easiest kind of front end for me. I'm planning to extract the application logic and add apps for Android / iOS later via React Native or some similiar technology.

Getting Started

To be defined

Prerequisites

• nodejs
• npm

npm install npm@latest -g

Installation

1. Clone the repo

git clone [e-mail]:lenaschimmel/riskjournal-cli.git

2. Install NPM packages

npm install

3. Run

npm run tsc && clear && node .

Usage

To be defined

Roadmap

To be defined

See the open issues for a list of proposed features (and known issues).

Contributing

To be defined

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Lena Schimmel - @lenaschimmel - [e-mail]

Project Link: https://github.com/lenaschimmel/riskjournal-cli

Acknowledgements

• microCOVID
• Readme template