osmanli-yatirim 0.3.8 → 0.4.1

package/README.md

@@ -1,29 +1,340 @@
-# osmanli-yatirim
+# osmali-micro-site
 
-## Project setup
+### 1. Paket Kurulumu:
+```bash
+npm i osmanli-yatirim
 ```
-npm install
+
+### 2. Store and Router Kullanımı
+`Store` ve `Router` otomatik olarak ilgili projedeki `router.js` ve `store.js` ile birleştirilmiş olacaktır. Haliyle bu konuyla alakalı sizin import işlemi yapmanıza gerek kalmayacaktır. 
+
+### 3. Paketin Entegre Edilmesi
+`main.js` dosyanızın aşağıdaki gibi olması yeterli olacaktır.
+
+```
+import Vue from "vue";
+import OsmanliPackage from "osmanli-yatirim";
+import App from "./App.vue";
+import router from "./router";
+import store from "./store";
+
+Vue.use(OsmanliPackage, { store });
+
+new Vue({
+  router,
+  store,
+  render: (h) => h(App),
+}).$mount("#app");
 ```
 
-### Compiles and hot-reloads for development
+### 4. Bileşenler Nasıl Kullanılır?
+NPM modülüne dönüştürülmüş olan componentleri aşağıdaki isimleriyle direkt kullanabilirsiniz.
+
+##### Örneğin;
+
+`App.vue`
 ```
-npm run serve
+<template>
+    <buy-sell-viop-transactions />
+    <transfer-tracking />
+    <securities-transfer />
+    <defined-bank-accounts />
+    <account-definition />
+    <transfer-request />
+    <fx-viop-warrant-transfer />
+    <apply-credit />
+    <public-offering-home-page />
+    <public-offer-request-entry />
+    <buy-sell-stocks />
+    <request-tracking />
+</template>
 ```
 
-### Compiles and minifies for production
+Component'lerin detaylı kullanımlarına aşağıdan ulaşabilirsiniz.
+
+### 5. View Olarak Nasıl Kullanılır? (Bonus)
+
+##### Hisse Emir Girişi
+
+`/views/e-sube/Stock` klasörlerini oluşturun ve içerisine `Stock.vue` adında bir dosya oluşturun. İçerisine aşağıdaki şekilde component register işlemi yapın.
+
 ```
-npm run build
+<template>
+    <buy-sell-stocks :tabName="this.$route.query.securityNo ? "buy" : this.$route.query.type || 'ozel-emir'" />
+</template>
 ```
 
-### Run your unit tests
+##### router.js
+```
+{
+    path: "/hisse/emir-girisi:type?",
+    name: "BuySellStock",
+    component: () => import("@/views/e-sube/Stock/Stock.vue"),
+    meta: {
+      requiresAuth: true
+      lyout: "AppLayout",
+      breadcrumb: [
+        {
+          name: "Dashboard",
+          icon: "dashboard",
+          url: { name: "Home" },
+        },
+      ],
+    },
+}
+```
+---
+##### Vadeli Emir Girişi
+
+`/views/e-sube/Viop` klasörlerini oluşturun ve içerisine `Viop.vue` adında bir dosya oluşturun. İçerisine aşağıdaki şekilde component register işlemi yapın.
+
+```
+<template>
+    <buy-sell-viop-transactions :tabName="this.$route.query.type || 'ozel-emir'" />
+</template>
+```
+##### router.js
+
+```
+{
+    path: "/vadeli/emir-girisi:type?",
+    name: "Viop",
+    component: () => import("@/views/e-sube/Viop/Viop.vue"),
+    meta: {
+      requiresAuth: true
+      lyout: "AppLayout",
+      breadcrumb: [
+        {
+          name: "Dashboard",
+          icon: "dashboard",
+          url: { name: "Home" },
+        },
+      ],
+    },
+}
+```
+---
+##### Halka Arz - Talep Anasayfa
+
+`/views/e-sube/PublicOffers/` klasörlerini oluşturun ve içerisine `PublicOfferingHomePage.vue` adında bir dosya oluşturun. İçerisine aşağıdaki şekilde component register işlemi yapın.
+
+```
+<template>
+    <public-offering-home-page />
+</template>
+```
+##### router.js
+```
+{
+    path: "/halka-arz-talep-anasayfa",
+    name: "PublicOfferingHomePage",
+    component: () => import("@/views/e-sube/PublicOffers/PublicOfferingHomePage.vue"),
+    meta: {
+      requiresAuth: true    
+    }
+}
+```
+---
+##### Halka Arz - Talep Girişi
+
+`/views/e-sube/PublicOffers/` klasörlerini oluşturun ve içerisine `PublicOfferRequestEntry.vue` adında bir dosya oluşturun. İçerisine aşağıdaki şekilde component register işlemi yapın.
+
+```
+<template>
+    <public-offer-request-entry />
+</template>
+```
+
+##### router.js
+
+```
+{
+    path: "/halka-arz-talep-girisi",
+    name: "PublicOfferRequestEntry",
+    component: () => import("@/views/e-sube/PublicOffers/PublicOfferRequestEntry.vue"),
+    meta: {
+      requiresAuth: true
+    }
+}
+```
+---
+
+##### Halka Arz - Talep İzleme
+
+`/views/e-sube/PublicOffers/` klasörlerini oluşturun ve içerisine `PublicOfferRequestTracking.vue` adında bir dosya oluşturun. İçerisine aşağıdaki şekilde component register işlemi yapın.
+
+```
+<template>
+    <request-tracking :tabName="this.$route.params.tabName || 'requestCollection'"/>
+</template>
+```
+
+##### router.js
+```
+{
+    path: "/halka-arz-talep-izleme",
+    name: "RequestTracking",
+    props: true,
+    component: () => import("@/views/e-sube/PublicOffers/PublicOfferRequestTracking.vue"),
+    meta: {
+      requiresAuth: true
+    }
+}
+```
+---
+
+##### Tanımlamalar - Kredi Limit Başvur
+
+`/views/e-sube/Profile/` klasörlerini oluşturun ve içerisine `ApplyCredit.vue` adında bir dosya oluşturun. İçerisine aşağıdaki şekilde component register işlemi yapın.
+
+```
+<template>
+    <apply-credit />
+</template>
+```
+
+##### router.js
+
+```
+{
+    path: "/tanimlamalar/kredi-basvur",
+    name: "ApplyCredit",
+    component: () => import("@/views/e-sube/Profile/ApplyCredit.vue"),
+    meta: {
+      requiresAuth: true
+    }
+}
+```
+----
+
+##### Bankacılık İşlemleri - Para Transferi
+
+`/views/e-sube/BankingOperations/` klasörlerini oluşturun ve içerisine `DefinedBankAccounts.vue` adında bir dosya oluşturun. İçerisine aşağıdaki şekilde component register işlemi yapın.
+
+```
+<template>
+    <defined-bank-accounts />
+</template>
+```
+
+##### router.js
+```
+{
+    path: "/para-transferi",
+    name: "DefinedBankAccounts",
+    component: () => import("@/views/e-sube/BankingOperations/DefinedBankAccounts.vue"),
+    meta: {
+      requiresAuth: true
+    }
+}
+```
+----
+
+##### Bankacılık İşlemleri - Menkul Transferi
+
+`/views/e-sube/BankingOperations/` klasörlerini oluşturun ve içerisine `SecuritiesTransfer.vue` adında bir dosya oluşturun. İçerisine aşağıdaki şekilde component register işlemi yapın.
+
+```
+<template>
+    <securities-transfer />
+</template>
+```
+
+##### router.js
+```
+{
+    path: "/menkul-transferi",
+    name: "SecuritiesTransfer",
+    component: () => import("@/views/e-sube/BankingOperations/SecuritiesTransfer.vue"),
+    meta: {
+      requiresAuth: true
+    }
+}
+```
+----
+
+##### Bankacılık İşlemleri - Transfer İzleme
+
+`/views/e-sube/BankingOperations/` klasörlerini oluşturun ve içerisine `TransferTracking.vue` adında bir dosya oluşturun. İçerisine aşağıdaki şekilde component register işlemi yapın.
+
+```
+<template>
+    <transfer-tracking :tabName="this.$route.query.tabName || this.$route.params.tabName || 'share'" />
+</template>
+```
+
+##### router.js
+
+```
+{
+    path: "/transfer-izleme/:tabName?",
+    name: "TransferTracking",
+    component: () => import("@/views/e-sube/BankingOperations/TransferTracking.vue"),
+    meta: {
+      requiresAuth: true,
+      layout: "AppLayout"
+    },
+}
+```
+----
+
+##### Bankacılık İşlemleri - Ara Ekranlar
+
+
+##### Hesap Tanımlama
+`/e-sube/BankingOperations/AccountDefinition.vue`
+```
+<template>
+    <account-definition />
+</template>
+```
+
+##### Para Transferi Talebi
+`/e-sube/BankingOperations/TransferRequest.vue`
+
+```
+<template>
+    <transfer-request />
+</template>
+```
+
+
+##### FX/VİOP Teminat Aktarımı
+`/e-sube/BankingOperations/FxViopWarrantTransfer.vue`
+
 ```
-npm run test:unit
+<template>
+    <fx-viop-warrant-transfer />
+</template>
 ```
 
-### Lints and fixes files
+##### router.js
 ```
-npm run lint
+{
+    path: "/hesap-tanimi",
+    name: "AccountDefinition",
+    component: () => import("@/views/e-sube/BankingOperations/AccountDefinition.vue"),
+    meta: {
+      requiresAuth: true
+    }
+},
+{
+    path: "/para-transferi-talebi",
+    name: "TransferRequest",
+    component: () => import("@/views/e-sube/BankingOperations/TransferRequest.vue"),
+    meta: {
+      requiresAuth: true
+    }
+},
+{
+    path: "/fx-viop-teminat-aktarimi",
+    name: "FxViopWarrantTransfer",
+    component: () => import("@/views/e-sube/BankingOperations/FxViopWarrantTransfer.vue"),
+    meta: {
+      requiresAuth: true
+    }
+}
 ```
 
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).
+#### Yapılandırmayı Özelleştir
+See [Yapılandırmayı Gör](https://cli.vuejs.org/config/).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "osmanli-yatirim",
-  "version": "0.3.8",
+  "version": "0.4.1",
   "private": false,
   "main": "./dist/OsmanliYatirimPackage.umd.min.js",
   "files": [