README.md

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

2. Go inside the folder by command

cd example-typescript

3. Run the command to install node modules

npm install

4. Start a web server by running using the following command

npm start

5. Access the url http://localhost:3000 and start Exploring!

Additional Resources

• Pieces OS Client SDK for TypeScript
• Pieces SDK Documentation
• Build Your Own Open Source Copilot with Pieces
• Build Your Own Copilot in Less Than 10 Minutes with Pieces OS Client

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

• Join Our Discord
• Follow us on Twitter
• Connect with us on LinkedIn
• Subscribe and turn on notifications to our YouTube page

License

This repository is available under the MIT License.