Skip to content

Commit abf7b08

Browse files
intisorintisor
authored
Update README.md
1 parent 606254c commit abf7b08

File tree

1 file changed

+243
-1
lines changed

1 file changed

+243
-1
lines changed

‎README.md‎

Lines changed: 243 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,243 @@
1-
# MalfuzatExplorer
1+
<p align="center">
2+
<img src="https://img.icons8.com/?size=512&id=55494&format=png" width="20%" alt="MALFUZATEXPLORER-logo">
3+
</p>
4+
<p align="center">
5+
<h1 align="center">MALFUZATEXPLORER</h1>
6+
</p>
7+
<p align="center">
8+
<img src="https://img.shields.io/github/last-commit/intisor/MalfuzatExplorer?style=flat&logo=git&logoColor=white&color=35cb2d" alt="last-commit">
9+
</p>
10+
11+
<br>
12+
13+
##### Table of Contents
14+
15+
- [ Overview](#-overview)
16+
- [ Features](#-features)
17+
- [ Repository Structure](#-repository-structure)
18+
- [ Modules](#-modules)
19+
- [ Project Roadmap](#-project-roadmap)
20+
21+
---
22+
23+
## Overview
24+
25+
<code>❯ REPLACE-ME</code>
26+
27+
---
28+
29+
## Features
30+
31+
<code>❯ REPLACE-ME</code>
32+
33+
---
34+
35+
## Repository Structure
36+
37+
```sh
38+
└── MalfuzatExplorer/
39+
├── Controllers
40+
│ └── HomeController.cs
41+
├── MalfuzatExplorer.csproj
42+
├── MalfuzatExplorer.sln
43+
├── Models
44+
│ ├── ErrorViewModel.cs
45+
│ └── MalfuzatModel.cs
46+
├── Program.cs
47+
├── Properties
48+
│ └── launchSettings.json
49+
├── README.md
50+
├── Views
51+
│ ├── Home
52+
│ ├── Shared
53+
│ ├── _ViewImports.cshtml
54+
│ └── _ViewStart.cshtml
55+
├── appsettings.Development.json
56+
├── appsettings.json
57+
└── wwwroot
58+
├── Malfuzat
59+
├── css
60+
├── favico.ico
61+
├── favicon.ico
62+
├── js
63+
└── lib
64+
```
65+
66+
---
67+
68+
## Modules
69+
70+
<details closed><summary>.</summary>
71+
72+
| File | Summary |
73+
| --- | --- |
74+
| [appsettings.json](https://github.com/intisor/MalfuzatExplorer/blob/main/appsettings.json) | <code>❯ REPLACE-ME</code> |
75+
| [MalfuzatExplorer.csproj](https://github.com/intisor/MalfuzatExplorer/blob/main/MalfuzatExplorer.csproj) | <code>❯ REPLACE-ME</code> |
76+
| [appsettings.Development.json](https://github.com/intisor/MalfuzatExplorer/blob/main/appsettings.Development.json) | <code>❯ REPLACE-ME</code> |
77+
| [MalfuzatExplorer.sln](https://github.com/intisor/MalfuzatExplorer/blob/main/MalfuzatExplorer.sln) | <code>❯ REPLACE-ME</code> |
78+
| [Program.cs](https://github.com/intisor/MalfuzatExplorer/blob/main/Program.cs) | <code>❯ REPLACE-ME</code> |
79+
80+
</details>
81+
82+
<details closed><summary>Properties</summary>
83+
84+
| File | Summary |
85+
| --- | --- |
86+
| [launchSettings.json](https://github.com/intisor/MalfuzatExplorer/blob/main/Properties/launchSettings.json) | <code>❯ REPLACE-ME</code> |
87+
88+
</details>
89+
90+
<details closed><summary>Views</summary>
91+
92+
| File | Summary |
93+
| --- | --- |
94+
| [_ViewImports.cshtml](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/_ViewImports.cshtml) | <code>❯ REPLACE-ME</code> |
95+
| [_ViewStart.cshtml](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/_ViewStart.cshtml) | <code>❯ REPLACE-ME</code> |
96+
97+
</details>
98+
99+
<details closed><summary>Views.Home</summary>
100+
101+
| File | Summary |
102+
| --- | --- |
103+
| [Privacy.cshtml](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/Home/Privacy.cshtml) | <code>❯ REPLACE-ME</code> |
104+
| [Index.cshtml](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/Home/Index.cshtml) | <code>❯ REPLACE-ME</code> |
105+
106+
</details>
107+
108+
<details closed><summary>Views.Shared</summary>
109+
110+
| File | Summary |
111+
| --- | --- |
112+
| [Error.cshtml](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/Shared/Error.cshtml) | <code>❯ REPLACE-ME</code> |
113+
| [_ValidationScriptsPartial.cshtml](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/Shared/_ValidationScriptsPartial.cshtml) | <code>❯ REPLACE-ME</code> |
114+
| [_Layout.cshtml](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/Shared/_Layout.cshtml) | <code>❯ REPLACE-ME</code> |
115+
| [_Layout.cshtml.css](https://github.com/intisor/MalfuzatExplorer/blob/main/Views/Shared/_Layout.cshtml.css) | <code>❯ REPLACE-ME</code> |
116+
117+
</details>
118+
119+
<details closed><summary>wwwroot.css</summary>
120+
121+
| File | Summary |
122+
| --- | --- |
123+
| [site.css](https://github.com/intisor/MalfuzatExplorer/blob/main/wwwroot/css/site.css) | <code>❯ REPLACE-ME</code> |
124+
125+
</details>
126+
127+
<details closed><summary>wwwroot.lib.jquery-validation-unobtrusive</summary>
128+
129+
| File | Summary |
130+
| --- | --- |
131+
| [LICENSE.txt](https://github.com/intisor/MalfuzatExplorer/blob/main/wwwroot/lib/jquery-validation-unobtrusive/LICENSE.txt) | <code>❯ REPLACE-ME</code> |
132+
| [jquery.validate.unobtrusive.js](https://github.com/intisor/MalfuzatExplorer/blob/main/wwwroot/lib/jquery-validation-unobtrusive/jquery.validate.unobtrusive.js) | <code>❯ REPLACE-ME</code> |
133+
| [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> |
134+
135+
</details>
136+
137+
<details closed><summary>wwwroot.lib.jquery</summary>
138+
139+
| File | Summary |
140+
| --- | --- |
141+
| [LICENSE.txt](https://github.com/intisor/MalfuzatExplorer/blob/main/wwwroot/lib/jquery/LICENSE.txt) | <code>❯ REPLACE-ME</code> |
142+
143+
</details>
144+
145+
<details closed><summary>wwwroot.js</summary>
146+
147+
| File | Summary |
148+
| --- | --- |
149+
| [site.js](https://github.com/intisor/MalfuzatExplorer/blob/main/wwwroot/js/site.js) | <code>❯ REPLACE-ME</code> |
150+
151+
</details>
152+
153+
<details closed><summary>Models</summary>
154+
155+
| File | Summary |
156+
| --- | --- |
157+
| [ErrorViewModel.cs](https://github.com/intisor/MalfuzatExplorer/blob/main/Models/ErrorViewModel.cs) | <code>❯ REPLACE-ME</code> |
158+
| [MalfuzatModel.cs](https://github.com/intisor/MalfuzatExplorer/blob/main/Models/MalfuzatModel.cs) | <code>❯ REPLACE-ME</code> |
159+
160+
</details>
161+
162+
<details closed><summary>Controllers</summary>
163+
164+
| File | Summary |
165+
| --- | --- |
166+
| [HomeController.cs](https://github.com/intisor/MalfuzatExplorer/blob/main/Controllers/HomeController.cs) | <code>❯ REPLACE-ME</code> |
167+
168+
</details>
169+
170+
---
171+
172+
## Getting Started
173+
174+
### Prerequisites
175+
176+
**None**: `version x.y.z`
177+
178+
### Installation
179+
180+
Build the project from source:
181+
182+
1. Clone the MalfuzatExplorer repository:
183+
```sh
184+
❯ git clone https://github.com/intisor/MalfuzatExplorer
185+
```
186+
187+
2. Navigate to the project directory:
188+
```sh
189+
❯ cd MalfuzatExplorer
190+
```
191+
192+
## Project Roadmap
193+
194+
- [X] **`Task 1`**: <strike>Implement IText7 Library for document processing.</strike>
195+
- [ ] **`Task 2`**: Did some business logics.
196+
- [ ] **`Task 3`**: Designed the UI.
197+
198+
---
199+
200+
## Contributing
201+
202+
Contributions are welcome! Here are several ways you can contribute:
203+
204+
- **[Report Issues](https://github.com/intisor/MalfuzatExplorer/issues)**: Submit bugs found or log feature requests for the `MalfuzatExplorer` project.
205+
- **[Submit Pull Requests](https://github.com/intisor/MalfuzatExplorer/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs.
206+
- **[Join the Discussions](https://github.com/intisor/MalfuzatExplorer/discussions)**: Share your insights, provide feedback, or ask questions.
207+
208+
<details closed>
209+
<summary>Contributing Guidelines</summary>
210+
211+
1. **Fork the Repository**: Start by forking the project repository to your github account.
212+
2. **Clone Locally**: Clone the forked repository to your local machine using a git client.
213+
```sh
214+
git clone https://github.com/intisor/MalfuzatExplorer
215+
```
216+
3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name.
217+
```sh
218+
git checkout -b new-feature-x
219+
```
220+
4. **Make Your Changes**: Develop and test your changes locally.
221+
5. **Commit Your Changes**: Commit with a clear message describing your updates.
222+
```sh
223+
git commit -m 'Implemented new feature x.'
224+
```
225+
6. **Push to github**: Push the changes to your forked repository.
226+
```sh
227+
git push origin new-feature-x
228+
```
229+
7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations.
230+
8. **Review**: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
231+
</details>
232+
233+
<details closed>
234+
<summary>Contributor Graph</summary>
235+
<br>
236+
<p align="left">
237+
<a href="https://github.com{/intisor/MalfuzatExplorer/}graphs/contributors">
238+
<img src="https://contrib.rocks/image?repo=intisor/MalfuzatExplorer">
239+
</a>
240+
</p>
241+
</details>
242+
243+
---

0 commit comments

Comments
 (0)