KITAB explore

A web portal for the KITAB project.

The portal gives access to the OpenITI metadata and the KITAB text reuse data and visualisations.

Features

• Extensive Collection: Browse through a vast repository of historical Arabic books from the OpenITI corpus.
• Metata Search Functionality: Search for specific works by author, title and other metadata.
• Explore Text Reuse Data: visualize the text reuse relations between two books, or between one book and all other books in the corpus
• Download: Download OpenITI text files and KITAB text reuse data.

Getting Started

To get started with KITAB explore, follow these steps:

1. Clone the Repository:

   git clone https://github.com/kitab-project-org/explore.git

2. Install Dependencies:

   cd kitabapps
   npm install # Or use yarn if preferred

3. Run the Application:

   npm start

   4. Access the Application:

   Open your web browser and navigate to http://localhost:8080.

Github Pages Build Process

To build the file for gh-pages locally, follow these steps:

1. Install Github Pages:

   npm install gh-pages

2. Add Scripts Inside package.json File:

   "predeploy": "npm run build", "deploy": "gh-pages -d build",

3. Build And Publish: try to build the app with

   npm run build

   then run this code:

   npm run deploy

4. Live Link:

You will get the live link at this location - https://your-github-username.github.io/repo-name/

gh-pages - build using actions

If deploying changes to the app, it is recommended that you use the actions script to do so. Use the following steps:

1. Ensure that your changes are merged into the main branch
2. Go to 'Actions'
3. Go to workflow: 'Deploy to GitHub Pages from main branch'
4. Click 'run workflow'
5. The workflow will build the react app into the gh-pages branch of the repository

Contributing

We welcome contributions to enhance the library and improve its features. To contribute:

Fork the repository.
Create a new branch for your feature: git checkout -b feature-name.
Commit your changes: git commit -m 'Add some feature'.
Push to the branch: git push origin feature-name.
Submit a pull request.

Issues

If you encounter any issues or have suggestions, please open an issue. We appreciate your feedback! License - https://github.com/kitab-project-org/explore/issues/new

This project is licensed under the MIT License - see the LICENSE file for details.

End