-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
243 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,243 @@ | ||
| # MalfuzatExplorer | ||
| <p align="center"> | ||
| <img src="https://img.icons8.com/?size=512&id=55494&format=png" width="20%" alt="MALFUZATEXPLORER-logo"> | ||
| </p> | ||
| <p align="center"> | ||
| <h1 align="center">MALFUZATEXPLORER</h1> | ||
| </p> | ||
| <p align="center"> | ||
| <img src="https://img.shields.io/github/last-commit/intisor/MalfuzatExplorer?style=flat&logo=git&logoColor=white&color=35cb2d" alt="last-commit"> | ||
| </p> | ||
|
|
||
| <br> | ||
|
|
||
| ##### Table of Contents | ||
|
|
||
| - [ Overview](#-overview) | ||
| - [ Features](#-features) | ||
| - [ Repository Structure](#-repository-structure) | ||
| - [ Modules](#-modules) | ||
| - [ Project Roadmap](#-project-roadmap) | ||
|
|
||
| --- | ||
|
|
||
| ## Overview | ||
|
|
||
| <code>❯ REPLACE-ME</code> | ||
|
|
||
| --- | ||
|
|
||
| ## Features | ||
|
|
||
| <code>❯ REPLACE-ME</code> | ||
|
|
||
| --- | ||
|
|
||
| ## 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 | ||
|
|
||
| <details closed><summary>.</summary> | ||
|
|
||
| | File | Summary | | ||
| | --- | --- | | ||
| | [appsettings.json](https://github.com/intisor/MalfuzatExplorer/blob/main/appsettings.json) | <code>❯ REPLACE-ME</code> | | ||
| | [MalfuzatExplorer.csproj](https://github.com/intisor/MalfuzatExplorer/blob/main/MalfuzatExplorer.csproj) | <code>❯ REPLACE-ME</code> | | ||
| | [appsettings.Development.json](https://github.com/intisor/MalfuzatExplorer/blob/main/appsettings.Development.json) | <code>❯ REPLACE-ME</code> | | ||
| | [MalfuzatExplorer.sln](https://github.com/intisor/MalfuzatExplorer/blob/main/MalfuzatExplorer.sln) | <code>❯ REPLACE-ME</code> | | ||
| | [Program.cs](https://github.com/intisor/MalfuzatExplorer/blob/main/Program.cs) | <code>❯ REPLACE-ME</code> | | ||
|
|
||
| </details> | ||
|
|
||
| <details closed><summary>Properties</summary> | ||
|
|
||
| | File | Summary | | ||
| | --- | --- | | ||
| | [launchSettings.json](https://github.com/intisor/MalfuzatExplorer/blob/main/Properties/launchSettings.json) | <code>❯ REPLACE-ME</code> | | ||
|
|
||
| </details> | ||
|
|
||
| <details closed><summary>Views</summary> | ||
|
|
||
| | File | Summary | | ||
| | --- | --- | | ||
| | [_ViewImports.cshtml](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/_ViewImports.cshtml) | <code>❯ REPLACE-ME</code> | | ||
| | [_ViewStart.cshtml](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/_ViewStart.cshtml) | <code>❯ REPLACE-ME</code> | | ||
|
|
||
| </details> | ||
|
|
||
| <details closed><summary>Views.Home</summary> | ||
|
|
||
| | File | Summary | | ||
| | --- | --- | | ||
| | [Privacy.cshtml](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/Home/Privacy.cshtml) | <code>❯ REPLACE-ME</code> | | ||
| | [Index.cshtml](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/Home/Index.cshtml) | <code>❯ REPLACE-ME</code> | | ||
|
|
||
| </details> | ||
|
|
||
| <details closed><summary>Views.Shared</summary> | ||
|
|
||
| | File | Summary | | ||
| | --- | --- | | ||
| | [Error.cshtml](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/Shared/Error.cshtml) | <code>❯ REPLACE-ME</code> | | ||
| | [_ValidationScriptsPartial.cshtml](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/Shared/_ValidationScriptsPartial.cshtml) | <code>❯ REPLACE-ME</code> | | ||
| | [_Layout.cshtml](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/Shared/_Layout.cshtml) | <code>❯ REPLACE-ME</code> | | ||
| | [_Layout.cshtml.css](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/Shared/_Layout.cshtml.css) | <code>❯ REPLACE-ME</code> | | ||
|
|
||
| </details> | ||
|
|
||
| <details closed><summary>wwwroot.css</summary> | ||
|
|
||
| | File | Summary | | ||
| | --- | --- | | ||
| | [site.css](https://github.com/intisor/MalfuzatExplorer/blob/main/wwwroot/css/site.css) | <code>❯ REPLACE-ME</code> | | ||
|
|
||
| </details> | ||
|
|
||
| <details closed><summary>wwwroot.lib.jquery-validation-unobtrusive</summary> | ||
|
|
||
| | File | Summary | | ||
| | --- | --- | | ||
| | [LICENSE.txt](https://github.com/intisor/MalfuzatExplorer/blob/main/wwwroot/lib/jquery-validation-unobtrusive/LICENSE.txt) | <code>❯ REPLACE-ME</code> | | ||
| | [jquery.validate.unobtrusive.js](https://github.com/intisor/MalfuzatExplorer/blob/main/wwwroot/lib/jquery-validation-unobtrusive/jquery.validate.unobtrusive.js) | <code>❯ REPLACE-ME</code> | | ||
| | [jquery.validate.unobtrusive.min.js](https://github.com/intisor/MalfuzatExplorer/blob/main/wwwroot/lib/jquery-validation-unobtrusive/jquery.validate.unobtrusive.min.js) | <code>❯ REPLACE-ME</code> | | ||
|
|
||
| </details> | ||
|
|
||
| <details closed><summary>wwwroot.lib.jquery</summary> | ||
|
|
||
| | File | Summary | | ||
| | --- | --- | | ||
| | [LICENSE.txt](https://github.com/intisor/MalfuzatExplorer/blob/main/wwwroot/lib/jquery/LICENSE.txt) | <code>❯ REPLACE-ME</code> | | ||
|
|
||
| </details> | ||
|
|
||
| <details closed><summary>wwwroot.js</summary> | ||
|
|
||
| | File | Summary | | ||
| | --- | --- | | ||
| | [site.js](https://github.com/intisor/MalfuzatExplorer/blob/main/wwwroot/js/site.js) | <code>❯ REPLACE-ME</code> | | ||
|
|
||
| </details> | ||
|
|
||
| <details closed><summary>Models</summary> | ||
|
|
||
| | File | Summary | | ||
| | --- | --- | | ||
| | [ErrorViewModel.cs](https://github.com/intisor/MalfuzatExplorer/blob/main/Models/ErrorViewModel.cs) | <code>❯ REPLACE-ME</code> | | ||
| | [MalfuzatModel.cs](https://github.com/intisor/MalfuzatExplorer/blob/main/Models/MalfuzatModel.cs) | <code>❯ REPLACE-ME</code> | | ||
|
|
||
| </details> | ||
|
|
||
| <details closed><summary>Controllers</summary> | ||
|
|
||
| | File | Summary | | ||
| | --- | --- | | ||
| | [HomeController.cs](https://github.com/intisor/MalfuzatExplorer/blob/main/Controllers/HomeController.cs) | <code>❯ REPLACE-ME</code> | | ||
|
|
||
| </details> | ||
|
|
||
| --- | ||
|
|
||
| ## 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`**: <strike>Implement IText7 Library for document processing.</strike> | ||
| - [ ] **`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. | ||
|
|
||
| <details closed> | ||
| <summary>Contributing Guidelines</summary> | ||
|
|
||
| 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! | ||
| </details> | ||
|
|
||
| <details closed> | ||
| <summary>Contributor Graph</summary> | ||
| <br> | ||
| <p align="left"> | ||
| <a href="https://github.com{/intisor/MalfuzatExplorer/}graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=intisor/MalfuzatExplorer"> | ||
| </a> | ||
| </p> | ||
| </details> | ||
|
|
||
| --- |