Skip to content

Latest commit

 

History

History
71 lines (45 loc) · 1.92 KB

README.md

File metadata and controls

71 lines (45 loc) · 1.92 KB
Raw

World Language Map RCL

This is a React component that renders a clickable world map. The continent clicked on will return the languages to the onContinentClick() function provided.

Clone the Repository

To clone the repository, run the following command:

git clone https://github.com/unfoldingWord/world-language-map-rcl.git

Installation

To install the dependencies and build the project, we recommend using pnpm. If you don't have pnpm installed, you can install it by running:

npm install -g pnpm

Once pnpm is installed, navigate to the project directory and run the following command to install the dependencies:

pnpm install

Development

To run the development server, use the following command:

pnpm dev

This will start the development server and you can view the component in your browser at http://localhost:5173.

Usage as a 3rd Party App

To use WorldLanguageMap as a 3rd party app, follow these steps:

  1. Install the package from npm:
npm install world-language-map-rcl
  1. Import the component into your project:
import { WorldLanguageMap } from 'world-language-map-rcl';
  1. Use the component in your code:
<WorldLanguageMap />

Props

The WorldLanguageMap component accepts the following props:

  • filterByCatalog
  • subjects (optional, defaults to all subjects): An array of strings representing the subjects to filter the catalog items.
  • metadataTypes (optional, defaults to all metadata types)
  • stage (optional, defaults to "prod"): A string that can be either "prod" (all releases), "latest" (master and all releases), or "other" (all branches, not just master) to specify the stage of the catalog items.
  • dcsApiUrl (optional, defaults to https://git.door43.org/api/v1): A string representing the URL of the DCS API.

License

This project is licensed under the MIT License.