Farajaland country configuration repository
An example configuration for OpenCRVS using a fictional country called Farajaland.
Report an issue · Join our community · Read our documentation · www.opencrvs.org
- What is this module for?
- How do I run the module alongside the OpenCRVS core?
- What is in the Farajaland configuration module repository?
**This is the fictional country "Farajaland" OpenCRVS country configuration repository for OpenCRVS You must fork this for your own country.**
Read our documentation to learn how to set up your own country configuration using this repo as an example.
## What is this module for?
This is an example country configuration package for the OpenCRVS core. OpenCRVS requires a country configuration in order to run.
OpenCRVS is designed to be highly configurable for your country needs. It achieves this by seeding reference data that it needs from this module and exposing APIs for certain business critical operations.
This module also provides a logical location where you may wish to store the code and run the servers for any custom API integrations, extension modules and innovations to OpenCRVS.
## How do I run the module alongside the OpenCRVS core?
1. Ensure that you are running OpenCRVS Core.
**If you successfully ran the `bash setup.sh` script in OpenCRVS Core you already have this module checked out, the dependencies are installed, the Farajaland database is populated and you can just run the following command.**
2. `yarn dev`
Thats it! 🎉
## What is in the Farajaland configuration module repository?
One of the key dependencies and enablers for OpenCRVS is country configuration and a reference data source. This source is bespoke for every implementing nation. If you would like to create your own country implementation, we recommend that you duplicate this repository and use it as a template. So what does it contain?
1. This repository contains:
- The "infrastructure" folder containing all Ans …