fakelab 0.0.2 → 0.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Alireza Hemati
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1 +1,75 @@
-# FAKELAB
+# Fakelab
+
+⚡ A fast, easy-config mock API server for frontend developers.
+
+## Features
+
+- 🚀 Instant mock server
+- 🗂️ Mock from Typescript files
+- 📦 Lightweight ~ 653 kB
+- 🧪 Perfect for local development, prototyping, and frontend testing
+
+## Installation
+
+```bash
+npm install fakelab --save-dev
+# or
+pnpm add -D fakelab
+# or
+yarn add -D fakelab
+```
+
+## Usage/Examples
+
+create `fakelab.config.ts` file in the project root. and reference your app interfaces files.
+
+```typescript
+import { defineConfig } from "fakelab";
+
+export default defineConfig({
+  sourcePath: "./interfaces", // can set a directory or a single typescript file.
+});
+```
+
+interfaces folder:
+
+```typescript
+export interface User {
+  name: string;
+  age: number;
+  admin: boolean;
+  address: string;
+  tags: string[];
+}
+export interface User {
+  gender: "male" | "female";
+}
+export interface Post {
+  id: string;
+  title: string;
+  content: string;
+  published: boolean;
+}
+
+export interface Profile {
+  id: string;
+  bio: string;
+  user: User;
+}
+```
+
+## Start the mock api server
+
+Run:
+
+```bash
+npx fakelab serve
+```
+
+## Related
+
+Fakelab is powered by [Fakerjs](https://fakerjs.dev/) library.
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fakelab",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "type": "module",
   "license": "MIT",
   "main": "lib/main.js",
@@ -57,6 +57,6 @@
     "zod": "^4.1.13"
   },
   "bin": {
-    "fakelab": "./bin/run.js"
+    "fakelab": "bin/run.js"
   }
 }