diff --git a/.github/AUTHORS b/.github/AUTHORS index b06e198..9a5941b 100644 --- a/.github/AUTHORS +++ b/.github/AUTHORS @@ -1,5 +1,3 @@ Himanshu Gupta -Alok Dubey -Ravi Verma Ghanshyam KD Hardik Jain <29hdkjain@gmail.com> \ No newline at end of file diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md index 5e6d07f..708e589 100644 --- a/.github/CODE_OF_CONDUCT.md +++ b/.github/CODE_OF_CONDUCT.md @@ -55,7 +55,7 @@ further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at <%= email %>. All +reported by contacting the project team at opensrc0@gmail.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. diff --git a/.github/SECURITY.md b/.github/SECURITY.md index e3d728b..76e712f 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -11,7 +11,8 @@ major version. | Version | Supported | | ------- | ------------------ | -| 1.0.x | :white_check_mark: | +| 2.0.x | :white_check_mark: | +| < 2.0 | :x: | ## Reporting a Vulnerability diff --git a/CHANGELOG.md b/CHANGELOG.md index 3214405..d06c8bc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ * **package.json:** changed command in package.json ([8e5d7fa](https://github.com/opensrc0/fe-pilot/commit/8e5d7fa42c928f96067c6951d876f0b73e91bba2)) * **resolved conflicts:** conflicts resolved ([d2f97d4](https://github.com/opensrc0/fe-pilot/commit/d2f97d489c7747fb95af023b99977ee19c0008d6)) + ## [1.0.1](https://github.com/opensrc0/fe-pilot/compare/v1.0.0...v1.0.1) (2024-2-26) diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b908a2e --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Himanshu Gupta + +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. \ No newline at end of file diff --git a/README.md b/README.md index dd9a38f..0a7c231 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,148 @@ -

FE-Pilot

-

A React UI library provide latest built in web feature

+

+fe-pilot Logo +

+

A React UI library for Advance JS Features 👨‍✈️


+

+ + Minified Size + + + React Version + + + NPM Downloads + + + Latest Release + +

+

+ + Github Stars + + + MIT License + +

+
+ +A React UI library for Advance Web Features that streamlines the development of modern web applications and websites. The library offers component like scanner, voice search, autofill otp, phonebook, share and many more for a small/medium/large size web based applications. Fe-Pilot is a easy to use, light weighted, fully mobile APP like features in web. + +## Table of contents +1. 🚀 [Features](#features) +2. 📦 [Installation](#installation) +3. 💻 [Usage](#usage) +4. 📚 [Online Editor Templates](#online-editor-templates) +5. 📝 [Contributing](#contributing) +6. ✨ [Contributors](#contributors) +7. ⚖️ [License](#license) + +## Features +- **Web/Mobile Support:** fe-pilot will be helpfull in Large/Mid/Small size of web based applications. +- **Ease of Use:** fe-pilot contains a set of components like `Scanner`, `PhoneBook`, `Voice Search`, `Share`, `Contact List`, `Live Location Tracking`, `Current Location` that are easy to plug and play. +- **Scalable & Maintainable:** fe-pilot components are built on top of a React for better scalable, maintainable component. + +## Installation +Install `fe-pilot` package using any package manager + +```sh +# with Yarn +$ yarn add fe-pilot + +# with npm +$ npm i fe-pilot --save + +# with pnpm +$ pnpm add fe-pilot + +# with Bun +$ bun add fe-pilot +``` + +## Usage + +#### 1. Use fe-pilot in your application +```js +import Scanner from 'fe-pilot/Scanner'; + + +``` + + +## Online Editor Templates + +#### 1. CodeSandbox +- JavaScript Starter: https://codesandbox.io/p/devbox/fe-pilot-js-6q2vcg + + + +#### 2. Stackblitz +- JavaScript Starter: https://stackblitz.com/edit/fe-pilot-js-b6mri2 + + + + +## Contributing + +Feel like contributing? Most welcome! +[Setup locally](./.github/SETUP.md) to get fe-pilot working on your local machine and [guide lines](./.github/CONTRIBUTING.md) to contribute in fe-pilot. + +## Contributors + +Thanks goes to these wonderful people + + + + + + + + + + + + + +
+ + Himanshu Gupta +
+ Himanshu Gupta + +
+ 		+ + Ghanshyam KD +
+ Ghanshyam KD + +
+ 		+ + Hardik Jain +
+ Hardik Jain + +
+ 		+ + Semantic Release Bot +
+ Semantic Release Bot + +
+ 		+ + Fossa Bot +
+ Fossa Bot + +
+
+ + + +## License + +MIT © [Himanshu Gupta](https://github.com/opensrc0) diff --git a/logo.png b/logo.png new file mode 100644 index 0000000..5a9b1f4 Binary files /dev/null and b/logo.png differ diff --git a/logol.png b/logol.png new file mode 100644 index 0000000..9d66e32 Binary files /dev/null and b/logol.png differ diff --git a/package.json b/package.json index debf201..79cc6c0 100644 --- a/package.json +++ b/package.json @@ -41,7 +41,16 @@ "react-components", "ui-component", "ui-library", - "web" + "web", + "advance-component", + "advance-feature", + "scanner", + "phonebook", + "voice", + "autofillotp", + "share", + "livelocationtracking", + "detectmylocation" ], "config": { "commitizen": {