Skip to content

Latest commit

 

History

History
91 lines (70 loc) · 3.65 KB

README.md

File metadata and controls

91 lines (70 loc) · 3.65 KB

React x Pieces

Introduction

This is a Sample React Project with the integration of Pieces npm package.

Prerequisites

Before setting up the project we need to download the Pieces OS application

Local Setup

NOTE: Commands are to be executed on Linux, Mac, and Windows(using Powershell)

  1. Clone the repo by running the command
git clone https://github.com/pieces-app/example-typescript.git
  1. Go inside the folder by command
cd example-typescript
  1. Run the command to install node modules
npm install
  1. Start a web server by running using the following command
npm start
  1. Access the url http://localhost:3000 and start Exploring!

Additional Resources

Contributing

We welcome your contributions to Pieces! All changes need a pull request & thumbs-up from our maintainers @shivay-at-pieces and @mason-at-pieces

We love ❤️ pull requests! Learn how to contribute in our guide: contribution guide.

Security

If you discover any security-related issues, create an issue and tag our maintainers @shivay-at-pieces and @mason-at-pieces

Connect with Us

License

This repository is available under the MIT License.