dhis2 / capture-app Goto Github PK

Next version DHIS 2 data capture app

License: BSD 2-Clause "Simplified" License

CSS 0.38% JavaScript 96.38% HTML 0.06% Gherkin 3.18% Shell 0.01%

web-app tx synced-settings

capture-app's Introduction

Capture app

The Capture app serves as a replacement for the Event Capture app. In the future, the intention is to incorporate the Tracker Capture app and the Data Entry app into the Capture app.

In the Capture app you register events that occurred at a particular time and place. An event can happen at any given point in time. This stands in contrast to routine data, which can be captured for predefined, regular intervals. Events are sometimes called cases or records. In DHIS2, events are linked to a program. The Capture app lets you select the organisation unit and program and specify a date when a event happened, before entering information for the event.

Find the official documentation of the Capture app here.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install and how to install them.

Node

You can download and install Node on your machine from here.

Git

You can find a tutorial on how to install git on your machine here.

Yarn 1

You can install yarn 1 on your machine following the instructions here.

Installing

Step by step instructions for setting up a development environment.

1. Clone the repository

Clone with SSH

git clone [email protected]:dhis2/capture-app.git

Clone with HTTPS

git clone https://github.com/dhis2/capture-app.git

2. Install project dependencies

To install the dependencies you will have to be at the source folder of the cloned repository. Then run:

yarn

3. Enable cross-site cookies in your browser (if server is running on a different domain)

Read about cross-site cookies and DHIS2 applications here

4. Run the application

To start the application locally and interact with it in the browser, run:

yarn start

http://localhost:3000 should automatically open in your browser.

You will be prompted for a path to the server instance, a user name and a password.

The path to the server instance can also be set by supplying a .env.development.local file in the root folder of the project. An example of an .env.development.local file:

REACT_APP_DHIS2_BASE_URL="http://localhost:8080"

Local Cypress testing

To run Cypress tests locally on your own machine, follow the instructions here.

Conditional E2E Test Recording

To record tests in Cypress Cloud, you can use one of the following methods based on your needs:

Commit Message: Include [e2e record] in your commit messages to activate recording.
GitHub Labels: Apply the e2e record label to your pull request to trigger recording.

This setup helps in managing Cypress Cloud credits more efficiently, ensuring recordings are only made when explicitly required.

Built With

This project was bootstrapped with Create React App.

Commits

We use Conventional Commits as convention for our commit messages.

License

This project is licensed under the BSD 2-Clause License - see the LICENSE.md file for details

capture-app's People

Contributors

Stargazers

Watchers

capture-app's Issues

Merge capture-core and capture-app for the time being

Ref. meeting 2018-01-29:

We discussed what the interface should be between various apps and the capture-core.

The problem is that we don't know what should go in capture-core, d2, and d2-ui. We agreed to merge capture-core into capture-app and treat it as a mono-repo for now to make development easier. Once we get into a place where we have the basic functionality we need for the capture app we can better evaluate how to extract core functionality into a common module.

Rewrite Formbuilder to accommodate external state

Formbuilder is already getting bloated, writing a new class for this use case. Use flow annotations.

load event-capture events

The automated release is failing 🚨

🚨 The automated release from the `master` branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

App Hub does not support publishing libraries.

The type in d2.config.js must not be 'lib'

Good luck with your project ✨

Your semantic-release bot 📦🚀

Extract reusable modules from capture app to d2, d2-ui and capture-core

When we are feature complete we will have a better idea about what goes where and are better able to create a well-defined interface between core functionality and application functionality.

This issue is a follow-up for #3.

POC for offline support

Integrate rules engine

Rewrite rules engine to pure javascript with flow annotations

fe-tech converstation

Proposals:
https://redux-toolkit.js.org/

PRs:
#1051 (comment)
#1056 (comment)

Other:
Where to save the hooks
When to use ComponentType on export

Implement "Selector" for program and orgunit

Request for a better documentation

It would be nice to have a better documentation on this project; the actual readme is the create-react-app documentation but it would be better to have more specific documentation of the project.

Maybe it's something that a main contributor can more easily do.

Write session storage adapter

Wireframes for navigation

Make a first working version of the wireframes for navigating the capture app.

Add flow annotations to storage adapters

Implementing data entry form with validations using dhis2/ui

hello,
I have created a program by using the dhis2 Program management module. Now I want to build the data entry form. I am building the fresh UI by using the dhis2/ui. I am able to render the normal form that is based in the program JSON that I get from DHIS2 api. But I am having difficulties in handling the program rules in my form. Is there any other library that may help in handling the program rules or any other way that will help me in simplifying the program rules. I have went through the program code and files that are used in capture-app which handles the program rules but I found out that the capture-app is mainly specific for the data capturing of events and also it very difficult to understand the implementation. It would be very helpful if you could guide me to move further.

Thanks,

Topics to be discussed on 10th July 2020

Hey this might be a good place to keep the topics we would like to discuss on our tech meeting.

Please feel free to add into this list by editing it @JoakimSM @Bekkalizer.

List of topics:

e2e tests with cypress