feat: add empty source

Author: KoLiBer

README.md

@@ -1,22 +1,49 @@
-# \${PROJECT_NAME}
+# loopback-component-filter
 
-\${PROJECT_DESCRIPTION}
+Using this simple extension you can filter models in repository level.
 
-## Dependencies
+---
+
+## Installation
 
-\${PROJECT_MODULES}
+```bash
+npm i --save loopback-component-filter
+```
 
 ---
 
-## Building
+## Usage
 
-\${PROJECT_BUILD}
+### Filter Repository Mixin
 
----
+Change your repository parent class from `DefaultCrudRepository` to `FilterCrudRepositoryMixin(configs)()`
+
+#### Example
+
+Change your repository from:
+
+```ts
+export class UserRepository extends DefaultCrudRepository<
+    User,
+    typeof User.prototype.id,
+    UserRelations
+> {
+    // ...
+}
+```
+
+To:
 
-## Testing
+```ts
+import { FilterCrudRepositoryMixin } from "loopback-component-filter";
 
-\${PROJECT_BUILD_ASSCINEMA_REC}
+export class UserRepository extends FilterCrudRepositoryMixin<
+    User,
+    UserRelations
+>(configs)() {
+    // ...
+}
+```
 
 ---
 

docs/README.md

@@ -1,4 +1,4 @@
-# \${PROJECT_NAME}
+# loopback-component-filter
 
 ## Product Owner
 
@@ -10,26 +10,21 @@
 
 ## Start Date (UTC)
 
--   \${PROJECT_DATE}
+-   2020-05-02T08:23:39.598Z
 
 ## Question
 
--   \${PROJECT_QUESTION}
+-   How to filter models in repository layer ?
 
 ## Goal
 
--   \${PROJECT_GOAL}
+-   Implement a filter in repository layer
 
 ## Languages and Frameworks
 
-1. **Client**
-    1. **HTML5**
-    2. **CSS3**
-    3. **JavaScript-ES7**
-    4. **React.js**
-2. **Server**
+1. **Server**
     1. **Node.js**
-    2. **Express.js**
+    2. **Loopback 4**
 
 ## SDLC (Software Development Life Cycle)
 
@@ -38,6 +33,6 @@
 ## Links
 
 [Trello]()
-[Gitlab]()
+[Gitlab](https://github.com/loopback4/loopback-component-filter)
 
 ## Description

sources/package.json

@@ -36,13 +36,15 @@
         "@loopback/boot": "^2.1.2",
         "@loopback/context": "^3.6.0",
         "@loopback/core": "^2.4.2",
+        "@loopback/repository": "^2.3.0",
         "tslib": "^1.10.0"
     },
     "devDependencies": {
         "@loopback/build": "^5.3.0",
-        "source-map-support": "^0.5.19",
         "@loopback/testlab": "^3.1.2",
         "@types/node": "^10.17.21",
+        "nodemon": "^2.0.3",
+        "source-map-support": "^0.5.19",
         "typescript": "~3.8.3"
     }
 }

sources/src/component.ts

@@ -1 +1,3 @@
-export * from './component';
+export * from "./types";
+
+export * from "./repositories";