Skip to content

OpenCRVS - Alpha 3.1

Pre-release
Pre-release
Compare
Choose a tag to compare
@euanmillar euanmillar released this 07 Feb 11:40
· 4970 commits to master since this release
1.0.0-alpha.3.1
7b994cd

Introduction

OpenCRVS Alpha 3.1 is a minor Alpha release for OpenCRVS.

This release contains a number of dependency upgrades, bug-fixes, some major new features and many minor improvements. This release includes:

  • An automated, local demo and development environment installation script
  • The default Zambia country configuration package has been replaced by a fictional country: Farajaland
  • Documentation improvements in advance of the public Beta v1.0 planned for mid 2022
  • Ability to add / edit a user's profile image
  • Ability for a user to change language in the login application
  • Ability to search all health facilities offline
  • Ability to search performance statistics for a single office as opposed to a jurisdiction such as a district.
  • A new styleguide component library
  • Miscellaneous bugfixes
  • UI design improvements
  • Dependency upgrades

The next major OpenCRVS release will be an official Beta planned for mid-2022. The Beta may be deemed a full OpenCRVS 1.0, after which point we will begin documenting breaking changes in all future releases.

Major Features

The following explains in more detail each major feature that has been included in this release.

An automated, local demo and development environment installation script

Previously, setting up a local, demo development environment of OpenCRVS was hard. It involved a number for commands to be run in sequence and without ports and dependencies being installed correctly, OpenCRVS would fail to start without informing the system administrator of the source of the problem.

This has been improved with a single command bash ./setup.sh. Running this command checks that all the dependencies have been in stalled correctly, checks that ports are available, builds all docker images, checks out the Farajaland default country configuration, starts OpenCRVS and populates the OpenCRVS databases with default country configuration.

With this single command OpenCRVS can be easily demo-ed and developed upon by new system administrators.

The default Zambia country configuration package has been replaced by a fictional country: Farajaland

Previously, the country configuration for an OpenCRVS 2019 pilot in Zambia was released as an example country configuration for OpenCRVS. IN order to become more generic in future releases and demo easier configuration tools planned for 2022, we have renamed and performed some upgrades. The default country configuration is now a fictional African country. "Farajaland". "Faraja" means "Blessings" in Swahili.

Documentation improvements in advance of the public Beta v1.0 planned for mid 2022

To accompany the past 2 points, the documentation in OpenCRVS Core and OpenCRVS Farajaland repositories has been updated and tested. Expect this documentation to become drastically simplified with regards to country configuration in the next release.

Ability to add / edit a user's profile image

It is now possible in the settings page, for a user to upload an avatar image. This image is used to make it easier for staff to quickly understand their team's actions. It also gives the user the added ability to personalise their OpenCRVS experience.

Ability for a user to change language in the login application

Previously, changing the default language of OpenCRVS was only possible in the main Client application. The default language for the Login application was configured in an environment variable and could not be changed by the user. Now, provided the country configuration contains more than one available language, it is possible for the user to use a select in the Login app to change their desired language independently.

Ability to search all health facilities offline

Previously, due to some technical debt, users could only search for health facilities offline from a list containing health facilities in their own jurisdiction. This proved restrictive as it stopped birth and death declarations from being submitted in an offline state, if the birth or death happened outside the jurisdiction. Now, the country's entire health facility list is available for searching offline.

Ability to search performance statistics for a single office as opposed to a jurisdiction such as a district

Previously, searching performance reports and statistics was restricted to jurisdictional searches down to district level. This is because some operational statistics are calculated using the populations, gender split and crude birth/death rates for a jurisdiction. These calculations now will not appear if searching for performance report on an office, meaning that operational reports can be accessed at the office level. It may be possible that in some countries a single jurisdiction can contain multiple civil registration offices.

A new styleguide component library

We have launched a new component library website using Storybook. Storybook is an open source tool for building UI components and pages in isolation. It streamlines UI development, testing, and documentation.

Miscellaneous bugfixes

Many bugs and performance issues have been resolved. Please refer to the Zenhub release report link at the bottom of this report to see specifics.

UI design improvements

Many minor UI design improvements have been made. Please refer to the Zenhub release report link at the bottom of this report to see specifics.

Dependency upgrades

  • HapiJS has been upgraded
  • Create React App, Jest and Typescript has been upgraded
  • Dependency security vulnerabilities in many node_modules have been resolved

What's Changed

Zenhub release report

New Contributors

Full Changelog: v1.0.0-alpha.3.0...1.0.0-alpha.3.1

Contributors

rikukissa, euanmillar, and 8 other contributors
Assets 2
Loading