Skip to content

Repository Structure

Jump to bottom
romantsisyk edited this page Feb 4, 2024 · 2 revisions

Repository Structure

The "Slavic Mythology Deities" repository is organized to provide easy access to deity data and related resources. Below is a breakdown of the directory structure:

User slavic-api/API
├── README.md
├── bg (directory)
│   ├── 001.json
│   ├── 002.json
│   ├── ...
│   └── 030.json
├── cz (directory)
│   ├── 001.json
│   ├── 002.json
│   ├── ...
│   └── 030.json
├── en (directory)
│   ├── 001.json
│   ├── 002.json
│   ├── ...
│   └── 030.json
├── images (directory)
│   ├── deities (directory)
│   │   ├── 001 (directory)
│   │   │   ├── detailImage.png
│   │   │   └── thumbnail.png
│   │   ├── 002 (directory)
│   │   │   ├── detailImage.png
│   │   │   └── thumbnail.png
│   │   ├── ...
│   │   └── 030 (directory)
│   │       ├── detailImage.png
│   │       └── thumbnail.png
├── pl (directory)
│   ├── 001.json
│   ├── 002.json
│   ├── ...
│   └── 030.json
├── sr (directory)
│   ├── 001.json
│   ├── 002.json
│   ├── ...
│   └── 030.json
├── ua (directory)
│   ├── 001.json
│   ├── 002.json
│   ├── ...
│   └── 030.json

Main Files

  • README.md: The primary documentation file that provides an overview of the project and instructions for use.

Data Directories

Bulgarian Data (bg)

  • Contains JSON files for Slavic deities with information presented in the Bulgarian language.
  • Includes 30 JSON files, each representing a deity.

Czech Data (cz)

  • Similar to the Bulgarian directory, this contains JSON files for deities with information in the Czech language.

English Data (en)

  • This directory houses JSON files presenting deity information in English.
  • It includes 30 JSON files, each representing a deity.

Polish Data (pl)

  • Similar to the Bulgarian and Czech directories, this contains JSON files for deities presented in the Polish language.

Serbian Data (sr)

  • Contains JSON files for Slavic deities with information presented in the Serbian language.

Ukrainian Data (ua)

  • Similar to the other language directories, this contains JSON files for deities with information in the Ukrainian language.

Image Resources (images)

  • This directory is dedicated to deity images.
  • Inside the deities subdirectory, each deity has a dedicated subdirectory named with its unique identifier (e.g., "001" for the first deity).
  • Within each deity subdirectory, you'll find two image files:
    • detailImage.png: A detailed image representation of the deity.
    • thumbnail.png: A thumbnail image for visual representation.

Usage

The repository structure is designed to facilitate easy access to deity data in multiple languages and related visual resources. Depending on your language preference or project requirements, you can explore the deity data in the respective language directories. The images directory provides visual representations of the deities, allowing for a more immersive experience.

Contributions

Contributions to this repository are encouraged. If you would like to enhance the deity data, add new deities, or make corrections, please follow the guidelines outlined in the project's README.md file.

Clone this wiki locally