Skip to content

leomorini/rnw-widget

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

React Native Web Widget

This project enables the creation of multi-platform widgets, including web widgets, browser extensions, and React Native libraries. It is designed to provide flexibility and ease of use for developers aiming to integrate widgets into websites, browsers, or mobile applications.

Features

  • Web Widget: Create widgets for embedding in websites.
  • Browser Extension: Build widgets for use as browser extensions (e.g., for Chrome).
  • React Native Library: Package and publish your own React Native widget library to npm.

Getting Started

Follow the steps below to clone the repository, install dependencies, and build widgets for your desired platform.

1. Clone the Repository

git clone <repository-url>

2. Install Dependencies

npm install or yarn install

3. Build for Your Platform

Choose the appropriate build command based on your target platform:

  • Web Widget To create a web widget, run:

    yarn build:web
    • The generated files (CSS and JS) will be located in the /docs directory.
    • Main file: index.web.js.
  • Browser Extension To create a browser extension, run:

    yarn build:extension
    • The generated files will be located in the /build directory.
    • Main file: index.extension.js.
  • React Native Library (mobile) To create and publish your React Native library, follow these steps:

    • Main file: index.js.
    • Configure the package for npm publication.
    • Run the following command:
    npm publish

About

This project enables the creation of multi-platform widgets, including web widgets, browser extensions, and React Native libraries. It is designed to provide flexibility and ease of use for developers aiming to integrate widgets into websites, browsers, or mobile applications.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • JavaScript 57.2%
  • HTML 34.3%
  • CSS 8.5%