From b99da109ccc21978da671cb465de2c6644a9492c Mon Sep 17 00:00:00 2001 From: Gimnath-Perera Date: Wed, 13 Sep 2023 14:17:58 +0530 Subject: [PATCH 1/2] doc: github-readme updated --- README.md | 83 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 82 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 86a366b..2fc1b87 100644 --- a/README.md +++ b/README.md @@ -1 +1,82 @@ -# mocktopus +

+ mocktopus-logo +

+ +# TypeScript Interface Mock Data Generator + +[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/your-username/your-project-name/blob/main/LICENSE) +[![Next.js Version](https://img.shields.io/badge/Next.js-13.0.0-blueviolet.svg)](https://nextjs.org/) +[![NextUI Version](https://img.shields.io/badge/NextUI-Your_Version-ff69b4.svg)](https://nextui.org/) +[![TypeScript Version](https://img.shields.io/badge/TypeScript-4.5.2-blue.svg)](https://www.typescriptlang.org/) + +Generate mock data effortlessly from TypeScript interfaces in a web application powered by Next.js and NextUI. + +![Demo](https://your-demo-gif-url.com) + +## Table of Contents + +- [TypeScript Interface Mock Data Generator](#typescript-interface-mock-data-generator) + - [Table of Contents](#table-of-contents) + - [About](#about) + - [Features](#features) + - [Getting Started](#getting-started) + - [Usage](#usage) + - [Contributing](#contributing) + - [License](#license) + +## About + +The TypeScript Interface Mock Data Generator is a user-friendly web application built with Next.js, NextUI, and TypeScript. It simplifies the process of generating mock data for TypeScript projects. Just provide one or more TypeScript interfaces, and the application will generate one or multiple rows of mock data for you. + +## Features + +- **TypeScript Interface-Based:** Input your TypeScript interfaces to generate data that matches your data structure. + +- **Multiple Data Types:** Supports a wide range of data types, including numbers, strings, dates, and custom types. + +- **Customization:** Fine-tune the generated data by specifying rules, formats, and constraints. + +- **Realistic Data:** Create realistic data by defining ranges, patterns, and dependencies. + +- **Preview:** Visualize and preview the generated data before exporting it. + +- **Export Data:** Export the generated mock data in various formats (JSON, CSV, etc.). + +- **Save Templates:** Save and reuse your interface templates for future use. + +- **Interactive Web Interface:** A sleek and user-friendly web application built with NextUI. + +- **MIT License:** Open-source and available for use in your projects. + +## Getting Started + +1. Clone this repository: + +`git clone https://github.com/your-username/your-project-name.git` + +2. Install dependencies: + + `cd your-project-name` + `yarn install` + +3. Run dev server: + `yarn dev` + +4. Open your browser and visit . + +## Usage + +1. **Input TypeScript Interfaces**: Define your TypeScript interfaces in the application. +2. **Configure Data Generation**: Set rules, constraints, and formats for each field. +3. **Preview Data**: Visualize the generated mock data. +4. **Export Data**: Download the generated data in various formats. +5. **Save Templates**: Save your interface templates for future use. +6. For detailed usage instructions, please refer to our Documentation. + +## Contributing + +We welcome contributions from the community! To contribute to this project, please follow our Contributing Guidelines. + +## License + +This project is licensed under the MIT License - see the LICENSE file for details. From c9ed265856c32b0376cb65b6fcb89846c6975efc Mon Sep 17 00:00:00 2001 From: Gimnath-Perera Date: Wed, 13 Sep 2023 14:26:41 +0530 Subject: [PATCH 2/2] doc: github-readme updated --- README.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 2fc1b87..531245a 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,22 @@

- mocktopus-logo + Project Logo

-# TypeScript Interface Mock Data Generator +# Mocktopus | TypeScript Interface Mock Data Generator [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/your-username/your-project-name/blob/main/LICENSE) [![Next.js Version](https://img.shields.io/badge/Next.js-13.0.0-blueviolet.svg)](https://nextjs.org/) -[![NextUI Version](https://img.shields.io/badge/NextUI-Your_Version-ff69b4.svg)](https://nextui.org/) [![TypeScript Version](https://img.shields.io/badge/TypeScript-4.5.2-blue.svg)](https://www.typescriptlang.org/) Generate mock data effortlessly from TypeScript interfaces in a web application powered by Next.js and NextUI. -![Demo](https://your-demo-gif-url.com) - ## Table of Contents -- [TypeScript Interface Mock Data Generator](#typescript-interface-mock-data-generator) +- [Mocktopus | TypeScript Interface Mock Data Generator](#mocktopus--typescript-interface-mock-data-generator) - [Table of Contents](#table-of-contents) - [About](#about) - [Features](#features) - [Getting Started](#getting-started) - - [Usage](#usage) - [Contributing](#contributing) - [License](#license) @@ -52,7 +48,7 @@ The TypeScript Interface Mock Data Generator is a user-friendly web application 1. Clone this repository: -`git clone https://github.com/your-username/your-project-name.git` +` git clone https://github.com/your-username/your-project-name.git` 2. Install dependencies: @@ -62,16 +58,14 @@ The TypeScript Interface Mock Data Generator is a user-friendly web application 3. Run dev server: `yarn dev` -4. Open your browser and visit . +4. Open your browser and visit http://localhost:3000. -## Usage +##Usage 1. **Input TypeScript Interfaces**: Define your TypeScript interfaces in the application. 2. **Configure Data Generation**: Set rules, constraints, and formats for each field. 3. **Preview Data**: Visualize the generated mock data. 4. **Export Data**: Download the generated data in various formats. -5. **Save Templates**: Save your interface templates for future use. -6. For detailed usage instructions, please refer to our Documentation. ## Contributing @@ -80,3 +74,5 @@ We welcome contributions from the community! To contribute to this project, plea ## License This project is licensed under the MIT License - see the LICENSE file for details. + +_Made with ❤️ by [Gimnath Perera](https://github.com/Gimnath-Perera)_