From abf7b08d068d167e39de0c7019af0c2ab3cc46ed Mon Sep 17 00:00:00 2001 From: Abdulawwal Intisor Date: Thu, 3 Oct 2024 20:49:06 +0100 Subject: [PATCH] Update README.md --- README.md | 244 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 243 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c60c578..05172cb 100644 --- a/README.md +++ b/README.md @@ -1 +1,243 @@ -# MalfuzatExplorer \ No newline at end of file +

+ MALFUZATEXPLORER-logo +

+

+

MALFUZATEXPLORER

+

+

+ last-commit +

+ +
+ +##### Table of Contents + +- [ Overview](#-overview) +- [ Features](#-features) +- [ Repository Structure](#-repository-structure) +- [ Modules](#-modules) +- [ Project Roadmap](#-project-roadmap) + +--- + +## Overview + +❯ REPLACE-ME + +--- + +## Features + +❯ REPLACE-ME + +--- + +## Repository Structure + +```sh +└── 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](https://github.com/intisor/MalfuzatExplorer/blob/main/appsettings.json) | ❯ REPLACE-ME | +| [MalfuzatExplorer.csproj](https://github.com/intisor/MalfuzatExplorer/blob/main/MalfuzatExplorer.csproj) | ❯ REPLACE-ME | +| [appsettings.Development.json](https://github.com/intisor/MalfuzatExplorer/blob/main/appsettings.Development.json) | ❯ REPLACE-ME | +| [MalfuzatExplorer.sln](https://github.com/intisor/MalfuzatExplorer/blob/main/MalfuzatExplorer.sln) | ❯ REPLACE-ME | +| [Program.cs](https://github.com/intisor/MalfuzatExplorer/blob/main/Program.cs) | ❯ REPLACE-ME | + +
+ +
Properties + +| File | Summary | +| --- | --- | +| [launchSettings.json](https://github.com/intisor/MalfuzatExplorer/blob/main/Properties/launchSettings.json) | ❯ REPLACE-ME | + +
+ +
Views + +| File | Summary | +| --- | --- | +| [_ViewImports.cshtml](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/_ViewImports.cshtml) | ❯ REPLACE-ME | +| [_ViewStart.cshtml](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/_ViewStart.cshtml) | ❯ REPLACE-ME | + +
+ +
Views.Home + +| File | Summary | +| --- | --- | +| [Privacy.cshtml](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/Home/Privacy.cshtml) | ❯ REPLACE-ME | +| [Index.cshtml](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/Home/Index.cshtml) | ❯ REPLACE-ME | + +
+ +
Views.Shared + +| File | Summary | +| --- | --- | +| [Error.cshtml](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/Shared/Error.cshtml) | ❯ REPLACE-ME | +| [_ValidationScriptsPartial.cshtml](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/Shared/_ValidationScriptsPartial.cshtml) | ❯ REPLACE-ME | +| [_Layout.cshtml](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/Shared/_Layout.cshtml) | ❯ REPLACE-ME | +| [_Layout.cshtml.css](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/Shared/_Layout.cshtml.css) | ❯ REPLACE-ME | + +
+ +
wwwroot.css + +| File | Summary | +| --- | --- | +| [site.css](https://github.com/intisor/MalfuzatExplorer/blob/main/wwwroot/css/site.css) | ❯ REPLACE-ME | + +
+ +
wwwroot.lib.jquery-validation-unobtrusive + +| File | Summary | +| --- | --- | +| [LICENSE.txt](https://github.com/intisor/MalfuzatExplorer/blob/main/wwwroot/lib/jquery-validation-unobtrusive/LICENSE.txt) | ❯ REPLACE-ME | +| [jquery.validate.unobtrusive.js](https://github.com/intisor/MalfuzatExplorer/blob/main/wwwroot/lib/jquery-validation-unobtrusive/jquery.validate.unobtrusive.js) | ❯ REPLACE-ME | +| [jquery.validate.unobtrusive.min.js](https://github.com/intisor/MalfuzatExplorer/blob/main/wwwroot/lib/jquery-validation-unobtrusive/jquery.validate.unobtrusive.min.js) | ❯ REPLACE-ME | + +
+ +
wwwroot.lib.jquery + +| File | Summary | +| --- | --- | +| [LICENSE.txt](https://github.com/intisor/MalfuzatExplorer/blob/main/wwwroot/lib/jquery/LICENSE.txt) | ❯ REPLACE-ME | + +
+ +
wwwroot.js + +| File | Summary | +| --- | --- | +| [site.js](https://github.com/intisor/MalfuzatExplorer/blob/main/wwwroot/js/site.js) | ❯ REPLACE-ME | + +
+ +
Models + +| File | Summary | +| --- | --- | +| [ErrorViewModel.cs](https://github.com/intisor/MalfuzatExplorer/blob/main/Models/ErrorViewModel.cs) | ❯ REPLACE-ME | +| [MalfuzatModel.cs](https://github.com/intisor/MalfuzatExplorer/blob/main/Models/MalfuzatModel.cs) | ❯ REPLACE-ME | + +
+ +
Controllers + +| File | Summary | +| --- | --- | +| [HomeController.cs](https://github.com/intisor/MalfuzatExplorer/blob/main/Controllers/HomeController.cs) | ❯ REPLACE-ME | + +
+ +--- + +## Getting Started + +### Prerequisites + +**None**: `version x.y.z` + +### Installation + +Build the project from source: + +1. Clone the MalfuzatExplorer repository: +```sh +❯ git clone https://github.com/intisor/MalfuzatExplorer +``` + +2. Navigate to the project directory: +```sh +❯ cd MalfuzatExplorer +``` + +## Project Roadmap + +- [X] **`Task 1`**: Implement 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: + +- **[Report Issues](https://github.com/intisor/MalfuzatExplorer/issues)**: Submit bugs found or log feature requests for the `MalfuzatExplorer` project. +- **[Submit Pull Requests](https://github.com/intisor/MalfuzatExplorer/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs. +- **[Join the Discussions](https://github.com/intisor/MalfuzatExplorer/discussions)**: Share your insights, provide feedback, or ask questions. + +
+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. + ```sh + git clone https://github.com/intisor/MalfuzatExplorer + ``` +3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name. + ```sh + 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. + ```sh + git commit -m 'Implemented new feature x.' + ``` +6. **Push to github**: Push the changes to your forked repository. + ```sh + 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 +
+

+ + + +

+
+ +---