docs: add framework README

This commit is contained in:
Bolaji Ayodeji 2021-08-10 08:42:47 +01:00 committed by Alessandro Casazza
parent 0f381d4cc6
commit bbfe3f2c5a
No known key found for this signature in database
GPG Key ID: 3AF41B06C6495D3D

View File

@ -1 +1,23 @@
# Next.js Local Provider # Commerce Layer Provider
⚠️ This provider is still a work in progress.
Before getting started, you should do the following:
- Create a Commerce Layer [developer account](https://commercelayer.io).
- Create a new [organization](https://commercelayer.io/docs/data-model/users-and-organizations/) for your business.
- Create an application with `sales_channel` kind.
Next, copy the `.env.template` file in this directory to `.env.local` in the main directory (which will be ignored by Git):
```bash
cp framework/commercelayer/.env.template .env.local
```
Next, add the application credentials from your organization application dashboard in `.env.local`.
## Contribute
Our commitment to Open Source can be found [here](https://vercel.com/oss).
If you find an issue with the provider or want a new feature, feel free to open a PR or [create a new issue](https://github.com/vercel/commerce/issues).