Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arindam200/example-nextjs
https://github.com/arindam200/example-nextjs
Last synced: about 13 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/arindam200/example-nextjs
- Owner: Arindam200
- Created: 2024-05-10T21:47:04.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-05-14T14:41:10.000Z (6 months ago)
- Last Synced: 2024-05-14T16:22:39.065Z (6 months ago)
- Language: TypeScript
- Size: 170 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
#
Pieces x Nextjs Chatbot
## Introduction
This is a Sample React Project with the integration of Pieces npm package.
## Prerequisites
Before setting up the project we need to:
1. Download the [Pieces OS application](https://docs.pieces.app/installation-getting-started/what-am-i-installing)
2. Install the [npm package](https://www.npmjs.com/package/@pieces.app/pieces-os-client)
## 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/Arindam200/example-Nextjs.git
```
2. Go inside the folder by command
```sh
cd example-Nextjs
```
3. Run the command to install node modules
```sh
npm install
```
4. Run the command to start the project
```sh
npm run dev
```
5. Open the browser and go to the URL `http://localhost:3000/` to see the project running.
## 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! Feel free to fork the repository, make your changes, and open a pull request.
## 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).