EpicSHACLVisualizer

project_description
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This project was developed as a part of ongoing research in SHACL rules for validating building models in the AEC domain.

(back to top)

Built With

• 
• 

(back to top)

Getting Started

This app runs on react and node js. Below are the instructions on getting started

Prerequisites

You need the following packages, installations in your local machine to run the above code

• npm

  npm install npm@latest -g

• Node.js

Installation

1. Clone the repo

   git clone https://github.com/sbalot/EpicSHACLVisualizer.git

2. Install NPM packages

   npm install

3. Fire up the website by going into the root folder and running

   npm start

4. Once the website loads, enter the url for the data graph and the shape graph. For now, you can enter any text for the gltf file field. Click on the view violations button, to see the results of the data validation.

5. The violating components will be highlighted in yellow.

(back to top)

Usage

This project is used to demostrate validation using SHACL rules. Some sample rules are available at https://github.com/sbalot/BIM4Ren_SHACLDB/tree/main/Shapes, while sample data graphs are available at https://github.com/sbalot/BIM4Ren_SHACLDB/tree/main/Data

(back to top)

Roadmap

Below are some features which are planned, but have no definite deadlines. If you are interested in contributing, let me know :)

• Allow URL inputs for gltf field
• Downloadable validation report (in turtle format)
• Add preloaded URL input fields as an example

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Madhumitha Senthilvel - [email protected]

Project Link: https://github.com/sbalot/EpicSHACLVisualizer

(back to top)

Acknowledgments

• Jeroen Werbrouck

This project received funding from the BIM4Ren H2020 EU-funded project under the grant agreement 820773.

(back to top)