Skip to content

Latest commit

 

History

History
257 lines (185 loc) · 8.54 KB

README.md

File metadata and controls

257 lines (185 loc) · 8.54 KB
Raw

MALFUZATEXPLORER-logo

MALFUZATEXPLORER


Table of Contents

Overview

❯ Malfuzat Explorer

A Web Application for Exploring Malfuzat

Malfuzat Explorer is an open-source web app designed to facilitate easy search and explorationof Malfuzat - compilation of the sayings of the Promised Messiah, Hazrat Mirza Ghulam Ahmad. With advanced search, multi-lingual support (Arabic & Urdu):

  • Provide easy access to Malfuzat for research and spiritual growth
  • Facilitate understanding and exploration of Islamic teachings
  • Promote preservation and dissemination of Malfuzat

Built with ASP.NET core MVC with Arabic/Urdu font support.

Contribute to improve and expand Malfuzat Explorer! Review our guidelines and join our community.

Contact: [[email protected] - https://www.linkedin.com/in/intitech07 ]

Features

❯ • Scan through the Malfuzat for user query

Repository Structure

└── MalfuzatExplorer/
    ├── Controllers
    │   └── HomeController.cs
    ├── MalfuzatExplorer.csproj
    ├── MalfuzatExplorer.sln
    ├── Models
    │   ├── ErrorViewModel.cs
    │   └── MalfuzatModel.cs
    ├── Program.cs
    ├── Properties
    │   └── launchSettings.json
    ├── README.md
    ├── Views
    │   ├── Home
    │   ├── Shared
    │   ├── _ViewImports.cshtml
    │   └── _ViewStart.cshtml
    ├── appsettings.Development.json
    ├── appsettings.json
    └── wwwroot
        ├── Malfuzat
        ├── css
        ├── favico.ico
        ├── favicon.ico
        ├── js
        └── lib

Modules

.
File Summary
appsettings.json ❯ REPLACE-ME
MalfuzatExplorer.csproj ❯ REPLACE-ME
appsettings.Development.json ❯ REPLACE-ME
MalfuzatExplorer.sln ❯ REPLACE-ME
Program.cs ❯ REPLACE-ME
Properties
File Summary
launchSettings.json ❯ REPLACE-ME
Views
File Summary
_ViewImports.cshtml ❯ REPLACE-ME
_ViewStart.cshtml ❯ REPLACE-ME
Views.Home
File Summary
Privacy.cshtml ❯ REPLACE-ME
Index.cshtml ❯ REPLACE-ME
Views.Shared
File Summary
Error.cshtml ❯ REPLACE-ME
_ValidationScriptsPartial.cshtml ❯ REPLACE-ME
_Layout.cshtml ❯ REPLACE-ME
_Layout.cshtml.css ❯ REPLACE-ME
wwwroot.css
File Summary
site.css ❯ REPLACE-ME
wwwroot.lib.jquery-validation-unobtrusive
File Summary
LICENSE.txt ❯ REPLACE-ME
jquery.validate.unobtrusive.js ❯ REPLACE-ME
jquery.validate.unobtrusive.min.js ❯ REPLACE-ME
wwwroot.lib.jquery
File Summary
LICENSE.txt ❯ REPLACE-ME
wwwroot.js
File Summary
site.js ❯ REPLACE-ME
Models
File Summary
ErrorViewModel.cs ❯ REPLACE-ME
MalfuzatModel.cs ❯ REPLACE-ME
Controllers
File Summary
HomeController.cs ❯ REPLACE-ME

Getting Started

Prerequisites

None: version x.y.z

Installation

Build the project from source:

  1. Clone the MalfuzatExplorer repository:
❯ git clone https://github.com/intisor/MalfuzatExplorer
  1. Navigate to the project directory:
❯ cd MalfuzatExplorer

Project Roadmap

  • Task 1: Implemented IText7 Library for document processing.
  • Task 2: Did some business logics.
  • Task 3: Designed the UI.

Contributing

Contributions are welcome! Here are several ways you can contribute:

Contributing Guidelines
  1. Fork the Repository: Start by forking the project repository to your github account.
  2. Clone Locally: Clone the forked repository to your local machine using a git client. 
    git clone https://github.com/intisor/MalfuzatExplorer
  3. Create a New Branch: Always work on a new branch, giving it a descriptive name. 
    git checkout -b new-feature-x
  4. Make Your Changes: Develop and test your changes locally.
  5. Commit Your Changes: Commit with a clear message describing your updates. 
    git commit -m 'Implemented new feature x.'
  6. Push to github: Push the changes to your forked repository. 
    git push origin new-feature-x
  7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
  8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
Contributor Graph