Skip to content

Latest commit

 

History

History
90 lines (57 loc) · 2.3 KB

README.md

File metadata and controls

90 lines (57 loc) · 2.3 KB

KitabApps - Historical Arabic Books Library

KitabApps Logo (Replace this with your project logo or relevant image)

KitabApps is a comprehensive library of historical Arabic books, providing a rich collection of literary and scholarly works. This project aims to preserve and make accessible a diverse range of Arabic texts from different historical periods.

Features

  • Extensive Collection: Browse through a vast repository of historical Arabic books.
  • Search Functionality: Easily search for specific books or topics of interest.
  • User-Friendly Interface: Intuitive design for a seamless user experience.
  • Responsive: Accessible on various devices, ensuring a consistent experience.

Getting Started

To get started with KitabApps, follow these steps:

  1. Clone the Repository:

    git clone https://github.com/sohailmerchant/kitabapps.git

  2. Install Dependencies:

    cd kitabapps
npm install # Or use yarn if preferred

  3. Run the Application:

    npm start
    1. Access the Application:

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

Github Pages Build Process

To build the file for gh-pages, 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/

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/sohailmerchant/kitabapps/issues/new

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

End