-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
494 additions
and
71 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2022 Weaverse | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,58 +1,65 @@ | ||
# Weaverse monorepo | ||
|
||
Seamlessly integrate your existing ecommerce store into Shopify with Weaverse. | ||
|
||
### Setup | ||
|
||
- The project is using git submodules for templates so for the first time cloning this project, if the submodule is not yet downloaded, use the following command: | ||
```bash | ||
git submodule update --init --recursive | ||
``` | ||
- Start developing Weaverse SDKs and Hydrogen demo with `npm run dev` or `nr dev`. | ||
- In order to make the `pilot` template to watch SDKs changes, you can manually set the `rexmi.config.js` `watchPaths` like this: | ||
```js | ||
watchPaths: [ | ||
'./public', | ||
'./.env', | ||
'../../packages/core/dist/index.js', | ||
'../../packages/react/dist/index.js', | ||
'../../packages/hydrogen/dist/index.js', | ||
], | ||
``` | ||
- However, do not commit it because this is template project and normal users don't need that. To make git stop track that file change, you can use following command in `weaverse-project`: | ||
`git update-index --assume-unchanged ./remix.config.js` | ||
- If you need git to track that file again, use the command: | ||
`git update-index --no-assume-unchanged ./remix.config.js` | ||
|
||
### Note for commiting git project with submodule: | ||
|
||
- We should commit & push the submodule update first then after the submodule got latest commit code => commit the sdks packages with the latest submodule signature | ||
|
||
### How to upgrade packages? | ||
|
||
To upgrade all packages, use: `nr up` or `npm run up` with these optional flags: | ||
|
||
- Add `--patch` to upgrade all packages to the latest patch version | ||
- Add `--minor` to upgrade all packages to the latest minor version | ||
- Add `--major` to upgrade all packages to the latest major version | ||
- Add `--version <version>` to upgrade/downgrade all packages to the specified version | ||
- If no flag is provided, the default is `--patch` | ||
|
||
E.g: | ||
|
||
```bash | ||
$ nr up # v1.0.0 -> v1.0.1 | ||
$ nr up --patch # v1.0.1 -> v1.0.2 | ||
$ nr up --minor # v1.0.2 -> v1.1.0 | ||
$ nr up --major # v1.1.0 -> v2.0.0 | ||
$ nr up --version 1.3.2 # v2.0.0 -> v1.3.2 | ||
``` | ||
|
||
- Add `-p` to publish all packages to npm after upgrading | ||
|
||
E.g: | ||
|
||
```bash | ||
$ nr up --patch -p | ||
# v1.0.1 -> v1.0.2 -> publish v1.0.2 to npm | ||
``` | ||
# Weaverse SDKs | ||
|
||
## Overview | ||
|
||
The "Weaverse SDKs" is a public collection of SDKs for integrating the Weaverse Headless CMS with modern React/JamStack | ||
frameworks such as Shopify Hydrogen, Remix, and Next.js. Developed by The Weaverse Team, these SDKs are designed to | ||
simplify and enhance the integration of dynamic, content-rich web applications with the Weaverse CMS. | ||
|
||
## Key Features | ||
|
||
- **Framework-Specific SDKs**: Tailored SDKs for various React/JamStack frameworks, ensuring flexible and efficient | ||
integration. | ||
- **Seamless CMS Integration**: Facilitates the integration of applications with the Weaverse Headless CMS. | ||
- **Community-Driven**: Open-source and community-focused, welcoming contributions and collaborative development. | ||
|
||
## Packages | ||
|
||
- [`@weaverse/core`](https://github.com/Weaverse/weaverse/tree/main/packages/core): Foundation package with core logic | ||
and framework-agnostic code. | ||
- [`@weaverse/react`](https://github.com/Weaverse/weaverse/tree/main/packages/react): React components and utilities for | ||
CMS integration. | ||
- [`@weaverse/hydrogen`](https://github.com/Weaverse/weaverse/tree/main/packages/hydrogen): SDK for Shopify Hydrogen | ||
integration with Weaverse CMS. | ||
- [`@weaverse/remix`](https://github.com/Weaverse/weaverse/tree/main/packages/remix): Integration tools for Remix | ||
applications with Weaverse CMS. | ||
- [`@weaverse/next`](https://github.com/Weaverse/weaverse/tree/main/packages/next): Utilities for integrating Next.js | ||
applications with Weaverse CMS. | ||
|
||
## Installation & Development | ||
|
||
### Getting Started | ||
|
||
1. **Fork & Clone**: Fork this repository and clone it to your local machine. | ||
|
||
2. **Submodule Setup**: Initialize and update the submodule to pull the sample project: | ||
```bash | ||
git submodule init | ||
git submodule update --recursive | ||
``` | ||
|
||
3. **Install Dependencies**: Navigate to the desired package or sample project and install dependencies: | ||
```bash | ||
npm install | ||
``` | ||
|
||
4. **Run Development Server**: Start the development server: | ||
```bash | ||
npm run dev | ||
``` | ||
|
||
### Contributing | ||
|
||
Your contributions are welcome to further enhance the Weaverse SDKs. Feel free to fork the repository, make changes, and | ||
submit pull requests with your improvements. | ||
|
||
## License | ||
|
||
This project is open-source and licensed under the MIT License. | ||
|
||
## About The Weaverse Team | ||
|
||
Passionate about empowering developers, The Weaverse Team is committed to creating innovative tools and solutions that | ||
simplify and enhance web development. Our focus is on fostering a vibrant community and driving forward the evolution of | ||
web technologies. | ||
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# @weaverse/core | ||
|
||
## Overview | ||
|
||
`@weaverse/core` is the foundational package of the Weaverse ecosystem, providing the essential logic and building | ||
blocks for Weaverse and Weaverse Items. This package offers framework-agnostic code, facilitating the creation of | ||
consistent and reusable components across various Weaverse packages. | ||
|
||
## Features | ||
|
||
- Core logic of the Weaverse platform. | ||
- Framework-agnostic components for broad compatibility. | ||
- Reusable codebase across different Weaverse packages. | ||
|
||
## Installation | ||
|
||
```bash | ||
npm install @weaverse/core | ||
``` | ||
|
||
## Usage | ||
|
||
`@weaverse/core` is primarily used by other Weaverse packages like `@weaverse/react`, `@weaverse/hydrogen`, etc. It's | ||
generally not used directly in projects but serves as a dependency for these framework-specific packages. | ||
|
||
## Contributing | ||
|
||
Contributions to the `@weaverse/core` package are welcome. Please refer to our contributing guidelines for more | ||
information. | ||
|
||
## License | ||
|
||
This project is created by The Weaverse Team ([https://weaverse.io](https://weaverse.io)) and is licensed under the MIT | ||
License. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.