forked from crowetic/commerce
Update README.md
This commit is contained in:
parent
8d489bf665
commit
742ac5786e
35
README.md
35
README.md
@ -9,7 +9,7 @@ Demo live at: [demo.vercel.store](https://demo.vercel.store/)
|
|||||||
|
|
||||||
This project is currently <b>under development</b>.
|
This project is currently <b>under development</b>.
|
||||||
|
|
||||||
## Goals and Features
|
## Features
|
||||||
|
|
||||||
- Performant by default
|
- Performant by default
|
||||||
- SEO Ready
|
- SEO Ready
|
||||||
@ -22,14 +22,24 @@ This project is currently <b>under development</b>.
|
|||||||
- Dark Mode Support
|
- Dark Mode Support
|
||||||
|
|
||||||
## Work in progress
|
## Work in progress
|
||||||
|
|
||||||
We're using Github Projects to keep track of issues in progress and todo's. Here is our [Board](https://github.com/vercel/commerce/projects/1)
|
We're using Github Projects to keep track of issues in progress and todo's. Here is our [Board](https://github.com/vercel/commerce/projects/1)
|
||||||
|
|
||||||
## Integrations
|
## Integrations
|
||||||
|
|
||||||
Next.js Commerce integrates out-of-the-box with BigCommerce. We plan to support all major ecommerce backends.
|
Next.js Commerce integrates out-of-the-box with BigCommerce. We plan to support all major ecommerce backends.
|
||||||
|
|
||||||
If you wish to work on a new cms/headless ecommerce provider, please check this repo https://github.com/vercel/commerce-framework and open a PR with your functions and utilities under the standard mentioned in the README.
|
|
||||||
|
## Goals
|
||||||
|
|
||||||
|
* **Next.js Commerce** should have a completely data **agnostic** UI
|
||||||
|
* **Aware of schema**: should ship with the right data schemas and types.
|
||||||
|
* All providers should return the right data types and schemas to blend correctly with Next.js Commerce.
|
||||||
|
* `@framework` will be the alias utilized in commerce and it will map to the ecommerce provider of preference- e.g BigCommerce, Shopify, Swell. All providers should expose the same standardized functions. _Note that the same applies for recipes using a CMS + an ecommerce provider._
|
||||||
|
|
||||||
|
There is a `framework` folder in the root folder that will contain multiple ecommerce providers.
|
||||||
|
|
||||||
|
Additionally, we need to ensure feature parity (not all providers have e.g. wishlist) we will also have to build a feature API to disable/enable features in the UI.
|
||||||
|
|
||||||
|
People actively working on this project: @okbel & @lfades.
|
||||||
|
|
||||||
## Troubleshoot
|
## Troubleshoot
|
||||||
|
|
||||||
@ -80,20 +90,9 @@ Our commitment to Open Source can be found [here](https://vercel.com/oss).
|
|||||||
6. Add proper store values to `.env.local`.
|
6. Add proper store values to `.env.local`.
|
||||||
7. Run `yarn dev` to build and watch for code changes
|
7. Run `yarn dev` to build and watch for code changes
|
||||||
8. The development branch is `development` (this is the branch pull requests should be made against).
|
8. The development branch is `development` (this is the branch pull requests should be made against).
|
||||||
On a release, the relevant parts of the changes in the `staging` branch are rebased into `master`.
|
On a release, `develop` branch is rebased into `master`.
|
||||||
|
|
||||||
## Goals
|
|
||||||
|
|
||||||
* **Next.js Commerce** should have a completely data **agnostic** UI
|
|
||||||
* **Aware of schema**: should ship with the right data schemas and types.
|
|
||||||
* All providers should return the right data types and schemas to blend correctly with Next.js Commerce.
|
|
||||||
* `@framework` will be the alias utilized in commerce and it will map to the ecommerce provider of preference- e.g BigCommerce, Shopify, Swell. All providers should expose the same standardized functions. _Note that the same applies for recipes using a CMS + an ecommerce provider._
|
|
||||||
|
|
||||||
There is a `framework` folder in the root folder that will contain multiple ecommerce providers.
|
|
||||||
|
|
||||||
Additionally, we need to ensure feature parity (not all providers have e.g. wishlist) we will also have to build a feature API to disable/enable features in the UI.
|
|
||||||
|
|
||||||
People actively working on this project: @okbel & @lfades.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user