Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated docs, install notes #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

mattguide
Copy link

Updated documentation to align with other projects, such as https://github.com/tryghost/. Included the Call for Contributors link. Made a space for additional apps as part of the toolkit.
Wrote more descriptive install and run process for the patient-app.


Covid Response App is an open-source COVID-19 repository using [Hapi-FHIR](https://hapifhir.io/) as a [FHIR](https://www.hl7.org/fhir/) server and [Angular](https://angular.io/) for front-end application.
Covid Response App is an open-source COVID-19 repository built with [Angular.js](https://angular.io/) for front-end application and [FHIR-R4](https://hl7.org/fhir/)-compliant backend API for interoperability.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Angular.js is a term specifically used for angular 1, we're currently using Angular 9.


* [Node](https://nodejs.org/en/)
* NPM :- Packaged with Node
* [Node](https://nodejs.org/en/) and [NPM](https://covid19.smilecdr.com/covid-response-app/) (packaged with Node)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link to official NPM website should be https://www.npmjs.com/

Thank you for taking the time to contribute. Please feel free to submit an issue or pull request.

# Contents
* **Patient App** - [readme](./tree/master/patient-app), [demo](https://covid19.smilecdr.com/covid-response-app/) - self-assessment COVID-19 tool
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Relative path for readme not working.


## Contributing
For installing and running, check out [the patient app README](./tree/master/patient-app) for getting started on this project.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Relative path for readme not working.

```
git clone https://github.com/hapifhir/covid-response-app.git
```
Change to the patient-app directory
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It will be necessary for a user to know that the patient-app directory will be in the root of cloned repo.

Copy link
Contributor

@AD1306 AD1306 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor changes to main docs and install notes.

@AD1306 AD1306 self-assigned this Apr 13, 2020
@keerthivasan-r
Copy link

I'm interested in this project. Can we have a list of issues? so, I can also contribute. Thanks

Sorry to spam in this thread

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants