-
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.
Merge pull request #48 from tigran-saatchyan/documentation/47-add-doc…
…strings-to-project [DOCUMENTATION] adds documentation - #47
- Loading branch information
Showing
35 changed files
with
1,147 additions
and
68 deletions.
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
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 |
|---|---|---|
|
|
@@ -7,13 +7,10 @@ | |
| <a href="https://github.com/tigran-saatchyan/UniMart_by_EvoQ/blob/master/LICENSE"><img src="https://img.shields.io/github/license/tigran-saatchyan/UniMart_by_EvoQ" alt="License"></a> | ||
| <a href="https://t.me/PythonistiC"><img src="https://img.shields.io/badge/[email protected]?logo=telegram" alt="Telegram"></a> | ||
| <a href="https://www.paypal.me/TigranSaatchyan"><img src="https://img.shields.io/badge/support-paypal-blue.svg?logo=paypal" alt="Support me on Paypal"></a> | ||
| <a href="https://github.com/tigran-saatchyan/UniMart_by_EvoQ"><img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit" alt="Support me on Paypal"></a> | ||
| </p> | ||
|
|
||
|
|
||
|
|
||
| [](https://github.com/tigran-saatchyan/UniMart_by_EvoQ) | ||
| [](https://opensource.org/licenses/MIT) | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| * [Background / Overview](#background--overview) | ||
|
|
@@ -25,20 +22,23 @@ | |
| * [Documentation](#documentation) | ||
| * [Browser Support](#browser-support) | ||
| * [Dependencies](#dependencies) | ||
| * [Todo](#todo) | ||
| * [Release History](#release-history) | ||
| * [Changelog](#changelog) | ||
| * [Issues](#issues) | ||
| * [Bugs](#bugs) | ||
| * [Deployment](#deployment) | ||
| * [Translations](#translations) | ||
| * [Authors](#authors) | ||
| * [Acknowledgments](#acknowledgments) | ||
| * [Support](#support) | ||
| * [License](#license) | ||
|
|
||
| ## Background / Overview | ||
|
|
||
| **UniMart by EvoQ API** is a tool that allows | ||
| developers to integrate e-commerce features | ||
| like product management, inventory control, | ||
| order processing, and customer data management | ||
| into their applications or websites, making it | ||
| easier to run online stores. | ||
|
|
||
| ## Features | ||
|
|
||
|
|
@@ -61,9 +61,29 @@ Open your terminal and type in. | |
| ### Setting up | ||
|
|
||
|
|
||
|
|
||
| ### Structure / Scaffolding | ||
| ```text | ||
| ========= Tigran Saatchyan ~ git version 2.34.1 | ||
| =============== ------------------------------------- | ||
| ================= Project: UniMart_by_EvoQ (2 branches) | ||
| === ============== | ||
| =================== Created: 5 days ago | ||
| ========== Language: | ||
| ========================== ======= ● Python (100.0 %) | ||
| ============================ ======== Authors: 100% Tigran Saatchyan 20 | ||
| ============================= ========= URL: [email protected]:tigran-saatchyan/UniMart_by_EvoQ.git | ||
| ============================ ========== Commits: 20 | ||
| ========== ============================ | ||
| ========= ============================= Lines of code: 1369 | ||
| ======== ============================ Size: 244.97 KiB (60 files) | ||
| ======= ========================== License: MIT | ||
| ========== | ||
| =================== | ||
| ============== === | ||
| ================= | ||
| =============== | ||
| ========= | ||
| ``` | ||
| <details> | ||
|
|
@@ -72,15 +92,58 @@ Open your terminal and type in. | |
| ```text | ||
| UniMart_by_EvoQ | ||
| app | ||
| ├── __init__.py | ||
| ├── api | ||
| │ ├── __init__.py | ||
| │ └── v1 | ||
| │ ├── __init__.py | ||
| │ ├── auth.py | ||
| │ ├── cart.py | ||
| │ ├── dependencies.py | ||
| │ ├── products.py | ||
| │ └── routers.py | ||
| ├── db | ||
| │ ├── __init__.py | ||
| │ └── db.py | ||
| ├── main.py | ||
| ├── migrations | ||
| │ ├── env.py | ||
| │ ├── README | ||
| │ ├── script.py.mako | ||
| │ └── versions | ||
| ├── models | ||
| │ ├── __init__.py | ||
| │ ├── base_model.py | ||
| │ ├── cart.py | ||
| │ ├── products.py | ||
| │ └── users.py | ||
| ├── repositories | ||
| │ ├── __init__.py | ||
| │ ├── cart.py | ||
| │ ├── products.py | ||
| │ └── users.py | ||
| ├── schemas | ||
| │ ├── __init__.py | ||
| │ ├── cart.py | ||
| │ ├── products.py | ||
| │ └── users.py | ||
| ├── services | ||
| │ ├── __init__.py | ||
| │ ├── cart.py | ||
| │ ├── managers.py | ||
| │ ├── products.py | ||
| │ └── validators.py | ||
| ├── settings | ||
| │ ├── __init__.py | ||
| │ ├── auth.py | ||
| │ └── config.py | ||
| └── utils | ||
| ├── __init__.py | ||
| ├── factories.py | ||
| ├── repository.py | ||
| ├── unitofwork.py | ||
| └── utils.py | ||
| ``` | ||
|
|
||
|
|
@@ -90,36 +153,27 @@ app | |
| <strong>Note:</strong> The scaffolding was generated with tree. | ||
|
|
||
| ## Documentation | ||
| - http://localhost:8000/ | ||
| - http://localhost:8000/docs | ||
| - http://localhost:8000/redoc | ||
|
|
||
| ## Dependencies | ||
|
|
||
| List of dependencies used in the project | ||
|
|
||
| [//]: # () | ||
| [//]: # (| **Main Libraries** | **Other Libraries** |) | ||
|
|
||
| [//]: # (|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|) | ||
|
|
||
| [//]: # (|  |  |) | ||
|
|
||
| [//]: # (|  |  |) | ||
| | **Main Libraries** | **Other Libraries** | | ||
| |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| |  |  | | ||
| |  |  | | ||
| |  |  | | ||
| |  |  | | ||
| | |  | | ||
| | |  | | ||
| | |  | | ||
| | |  | | ||
|
|
||
| [//]: # (|  |  |) | ||
|
|
||
| [//]: # (|  |  |) | ||
|
|
||
| [//]: # (|  |  |) | ||
|
|
||
| [//]: # (| |  |) | ||
|
|
||
| [//]: # (| |  |) | ||
|
|
||
| [//]: # (| |  |) | ||
|
|
||
|
|
||
| ## Todo | ||
| [//]: # (## Todo) | ||
|
|
||
|
|
||
| ## Release History | ||
|
|
@@ -143,8 +197,7 @@ Please make sure to read the [Issue Reporting Checklist](https://github.com/tigr | |
|
|
||
| If you have questions, feature requests or a bug you want to report, please click [here](https://github.com/tigran-saatchyan/UniMart_by_Evoq/issues) to file an issue. | ||
|
|
||
| ## Deployment | ||
|
|
||
| [//]: # (## Deployment) | ||
|
|
||
| ## Translations | ||
|
|
||
|
|
||
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
Oops, something went wrong.