Contribute Historical Data

Help expand the database by contributing new eras, countries, or events to our open-source datasets.

1. Fork the Repository

Visit our data repository on GitHub and fork it to your own account.

2. Add or Edit JSON Data

Navigate to the appropriate language directory and edit the files. You can add new events, refine descriptions, or introduce new eras.

3. Create a Pull Request

Commit your changes and submit a Pull Request to the main branch. Once reviewed, your additions will be live on the timeline.

Data Schema Formats

The repository uses a simple JSON structure for index lists and country datasets. Below are the outlines of what you can contribute:

Located at data/{lang}/countries/{country_id}.json. This defines the overall structure of eras and chronological historical events.

Fields description:

eras: List of epochs/periods used for timeline filtering in navigation.
nodes: The actual historical events.
parentId: The parent node ID. Use null for initial starting nodes, or specify a parent event ID to draw branching lines.
date: Object with year (use negative for BC/BCE) and optional month / day.

{
  "id": "korea",
  "name": "대한민국",
  "color": "#3b82f6",
  "eras": [
    {
      "id": "goryeo",
      "name": "고려 시대",
      "startDate": {
        "year": 900
      },
      "endDate": {
        "year": 1392
      }
    }
  ],
  "nodes": [
    {
      "id": "goryeo_tripitaka",
      "date": {
        "year": 1236,
        "month": 5, // optional
        "day": 10   // optional
      },
      "parentId": "goryeo", // parent node ID or null if root
      "color": "#10b981",
      "branchName": "고려",
      "title": "팔만대장경 조판 시작",
      "description": "몽골의 침입에 맞서 불력으로 나라를 구하고자 목판에 불교 경전을 새겨 넣은 팔만대장경 조판이 추진되다."
    }
  ]
}