diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..6efe9205b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +## Contributing to Cohort360 + +As an open source project, **Cohort360** welcomes contributions of many forms: + * Creating an issue for bug report + * Readme improvements + * New feature you would like **Cohort360** to have + +To help make your contribution to this project successful, we do have a few guidelines in place. + +Each PR, no matter how small, should have a GitHub **issue** associated with it. + +Here's a quick checklist for a **good PR**: + +1. A GitHub Issue with a good description associated with the PR +2. One feature/change per PR +3. We use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) for more readability. This helps generate a well + organized changelog file +4. One commit per PR. If necessary, squash commits before pushing you branch +5. Rebased your branch on main (`git rebase`, not `git pull`) +6. Add a good descriptive commit message, with link to issue. + For example: + > feat(cohort): add amazing feature #issue-number +7. No changes to code not directly related to your PR/issue +8. Add tests to cover new code +9. Run tests locally before pushing changes + + +Once you have submitted your PR please monitor it for comments/feedback. + +We appreciate your help to make **Cohort360** an even better open source project! \ No newline at end of file diff --git a/README.md b/README.md index a71cf72e4..90c1eb2ba 100644 --- a/README.md +++ b/README.md @@ -1,68 +1,114 @@ -
- Cohort360 logo -

A web application to find patients, build cohorts and visualize data.

-
+
+ Cohort360 logo +

Explore patient data πŸ”, build cohorts πŸ‘₯ and export data πŸ“₯πŸ“Š Works with FHIR πŸ”₯

-# Cohort360 +
[![Actions Status](https://github.com/aphp/Cohort360-FrontEnd/workflows/cohort360-main-pipeline/badge.svg)](https://github.com/aphp/Cohort360-FrontEnd/actions) [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=aphp_Cohort360&metric=alert_status)](https://sonarcloud.io/dashboard?id=aphp_Cohort360) +
+ +Report a bug +Β· +What's new ? +
+ +--- + + +
+ Table of Contents +
    +
  1. + Overview + +
    2. +
  2. + Project Setup + +
    3. +
  3. Contributing
    4. +
  4. License
    5. +
  5. Contact
    6. +
+
+## Overview -## Architecture +### πŸ”‘ Features -- [ ] Add Architecture schema +* Explore, visualize, and search patient data +* Run advanced search queries on textual documents +* Create patient cohorts using a dedicated, user-friendly query builder +* Build queries with data criteria, complexity, and temporal constraints +* Get insights into cohorts at a glance +* Export cohort data for in-depth analysis -Cohort360 consists of a React front-end and a Django back-end (REST API). +### πŸ”₯ Based on FHIR -This repository hosts the front-end, while the back-end will be available soon. +Cohort360 accesses health data through a FHIR server. -Both the front-end and the back-end depend on a third, possibly custom, party: an endpoint to query medical data and to create cohorts. -This third endpoint can be a FHIR API for example. This is the case for the first creators of Cohort360. +[FHIR](https://www.hl7.org/fhir/) is the world’s most widely used standard for exposing health data via APIs. -## Installation +### πŸ› οΈ Built With -### Requirements: +* React +* ... -* A running back-end server -* A running third party endpoint (FHIR API for example) -* An authentication server -* Node.js (16 or higher) installed -### Running the front-end +## πŸš€ Project setup -1. First copy the `.env.example` file to `.env` and edit this file to match your configuration. -2. Run `npm install` -3. Run `npm audit fix` -4. Run `npm run build` +### 1. πŸ’  Requirements -This will generate files in the `build` directory that can be exposed via a web server like Nginx, or a node server. +To run Cohort360 locally, you'll need the following applications running: +πŸ“Œ [Cohort360-backend](https://github.com/aphp/Cohort360-Back-end/blob/enrich_repo_files/README.md) +πŸ“Œ A FHIR API to retrieve medical data -An example configuration with Nginx can be found [here](.templates/nginx.conf) +### 2. πŸ“₯ Get the code -## CI +```sh +git clone https://github.com/aphp/Cohort360-FrontEnd.git +``` -A [gitlab-ci.yml](.templates/.gitlab-ci.yml) is available in the `.templates` folder, alongside -a [nginx configuration](.templates/nginx.conf) example (useful for deployment). +### 3. πŸ”§ Configuration -## Deployment +> To do : specify what configuration is needed: env vars, extra files to create to hold special configurations -A docker image is available to build via the [Dockerfile](Dockerfile). You only need to update the location of your nginx conf. +### 4. ▢️ Run the app + +Start development server + +```shell +npm start +``` + +All set up πŸŽ‰ + +Check the application running on [http://localhost:3000](http://localhost:3000) + +
+ ⬆️ back to top +
-## Start Contributing -A contributing guide will be published soon. +## 🀝 Contributing -## Partners +See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed process about contributing to this repository. -* AP-HP Clinical Data Warehouse -* Arkhn : [arkhn.org](https://arkhn.org/) -* Akimed : [www.akimed.io](https://www.akimed.io/) +## πŸ“œ License -## Contributors +**Cohort360** is licensed under the Apache License - see the [LICENSE](LICENSE) file for details. -Coming soon... +## πŸ’¬ Contact -## License -Cohort360 is licensed under Apache License 2. +If you find this project useful, please consider starring the repository and report any encountered bugs or issues. +Write to us at: **open-source@cohort360.org** diff --git a/public/logo_C360.png b/public/logo_C360.png new file mode 100644 index 000000000..967806424 Binary files /dev/null and b/public/logo_C360.png differ