Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pieces-app/example-typescript
A React example project showing how to get started with Pieces TS SDK.
https://github.com/pieces-app/example-typescript
Last synced: 22 days ago
JSON representation
A React example project showing how to get started with Pieces TS SDK.
- Host: GitHub
- URL: https://github.com/pieces-app/example-typescript
- Owner: pieces-app
- License: mit
- Created: 2023-10-26T16:18:07.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-27T06:23:36.000Z (4 months ago)
- Last Synced: 2024-11-26T20:11:49.832Z (26 days ago)
- Language: TypeScript
- Homepage:
- Size: 656 KB
- Stars: 43
- Watchers: 3
- Forks: 50
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-pieces - Example Typescript Playground
- awesome-pieces - Example Typescript Playground
README
#
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](https://docs.pieces.app/installation-getting-started/what-am-i-installing)
## Local Setup
`NOTE: Commands are to be executed on Linux, Mac, and Windows(using Powershell)`
1. Clone the repo by running the command
```sh
git clone https://github.com/pieces-app/example-typescript.git
```
2. Go inside the folder by command
```sh
cd example-typescript
```
3. Run the command to install node modules
```sh
npm install
```
4. Start a web server by running using the following command
```sh
npm start
```
5. Access the url `http://localhost:3000` and start Exploring!
## Additional Resources
- [Pieces OS Client SDK for TypeScript](https://github.com/pieces-app/pieces-os-client-sdk-for-typescript)
- [Pieces SDK Documentation](https://docs.pieces.app/build/reference/typescript/)
- [Build Your Own Open Source Copilot with Pieces](https://code.pieces.app/blog/build-your-own-open-source-copilot-with-pieces)
- [Build Your Own Copilot in Less Than 10 Minutes with Pieces OS Client](https://code.pieces.app/blog/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](https://github.com/shivay-at-pieces) and [@mason-at-pieces](https://github.com/mason-at-pieces)
We love ❤️ pull requests! Learn how to contribute in our guide: [contribution guide](https://github.com/pieces-app/example-typescript/blob/main/CONTRIBUTING.md).
## Security
If you discover any security-related issues, create an issue and tag our maintainers [@shivay-at-pieces](https://github.com/shivay-at-pieces) and [@mason-at-pieces](https://github.com/mason-at-pieces)
## Connect with Us
- Join Our [Discord](https://discord.gg/getpieces)
- Follow us on [Twitter](https://twitter.com/getpieces)
- Connect with us on [LinkedIn](https://www.linkedin.com/company/getpieces)
- Subscribe and turn on notifications to our [YouTube page](https://www.youtube.com/@getpieces)
## License
This repository is available under the [MIT License](./LICENSE).
