Skip to content

Iduoad/Mrrakc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mrrakc

Mrrakc is a structured data project that documents places, people, and provinces in Morocco, with a focus on cultural, historical, and geographical information.

🗂️ Project Structure

  • data/ - Contains all the data files organized by type:
    • people/ - Information about notable individuals
    • places/ - Information about locations, landmarks, and sites
    • provinces/ - Information about administrative regions
  • schema/ - JSON schema definitions that validate the data structure
  • scripts/ - Utility scripts for validating and working with the data

🚀 Getting Started

Prerequisites

  • Node.js (v14 or later)
  • Just command runner (optional, for convenience)
  • Docker (optional, for containerized validation)

Installation

Clone the repository:

git clone https://github.com/yourusername/mrrakc.git
cd mrrakc

Validation

To validate all data files:

node scripts/validate.js

If you have Just installed:

just validate

Using Docker (no local dependencies required):

just docker-validate

📝 Data Structure

Places

Places represent physical locations such as museums, parks, historical sites, etc. Each place has:

  • Categorization (kind) in the format category/type (e.g., culture/museum)
  • Name and slug identifier
  • Description
  • Geographic location (province, coordinates)
  • Associated people
  • Timeline of significant events
  • Access information
  • Links to external resources

People

People represent notable individuals associated with places. Each person has:

  • Name and slug identifier
  • Biographical information
  • Birth place
  • Designations (roles/professions)
  • Timeline of significant events
  • Links to external resources

Provinces

Provinces represent administrative regions in Morocco. Each province has:

  • Name and slug identifier
  • Region (larger administrative area it belongs to)
  • Country (always "Morocco")

🤝 Contributing

We welcome contributions! Please see CONTRIBUTING.md for details on how to add or modify data.

📊 Usage Ideas

This dataset can be used for:

  • Creating interactive maps of cultural and historical sites
  • Building educational tools about Moroccan heritage
  • Developing tourism applications
  • Research on historical connections between people and places
  • Analysis of cultural landmarks and their distribution

📄 License

This project is licensed under [LICENSE] - see the LICENSE file for details.

🙏 Acknowledgements

  • Contributors who have added data to this project
  • Open source tools and libraries that make this project possible

About

No description, website, or topics provided.

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages