Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readme article #3

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

readme article #3

wants to merge 1 commit into from

Conversation

christopherbWIX
Copy link
Collaborator

No description provided.

Copy link
Owner

@RoyNoymanW RoyNoymanW left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

Copy link

@adsac adsac left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great. Left a few small suggested edits.


- **Wix CLI:** Get a comprehensive developer experience with minimal setup and host your app on Wix with one command. Learn more about the [Wix CLI for apps](https://dev.wix.com/docs/build-apps/developer-tools/cli/get-started/about-the-wix-cli-for-apps).
- **Wix Design System:** Utilize Wix's reusable React components for a cohesive user experience consistent with Wix's design standards.
- **Wix eCommerce Orders API**: Access and manage Wix eCommerce Orders data on a Wix site (this data is for orders made through the Wix Stores app). Learn more about the [Wix eCommerce API](https://dev.wix.com/docs/sdk/backend-modules/ecom/introduction).
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need the parenthetical comment here? eCom Orders can (in principle) also be used with orders created with Bookings, Restaurants, etc.

If so, maybe be more specific and say that the eCom Orders API is for use with all Wix eCommerce flows, but in this case it's for use with products sold via Stores.

- **Wix eCommerce Orders API**: Access and manage Wix eCommerce Orders data on a Wix site (this data is for orders made through the Wix Stores app). Learn more about the [Wix eCommerce API](https://dev.wix.com/docs/sdk/backend-modules/ecom/introduction).
- **Backend API**: Define your own HTTP functions that can be called from your frontend code. Learn more about [Backend APIs](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/wix-cli/supported-extensions/backend-extensions/api/add-api-extensions-with-the-cli).
- **Dashboard modal:** Extend your Wix app's functionality by adding modals to your app's dashboard. Learn more about [Dashboard modals](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/wix-cli/supported-extensions/dashboard-extensions/dashboard-modals/add-dashboard-modal-extensions-with-the-cli).
- **Dashboard menu plugin:** Extend your Wix app's functionality by adding menu plugins to the user interfaces of an apps built by Wix. Learn more about [Dashboard menu plugin extensions](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/dashboard-extensions/dashboard-plugins/dashboard-menu-plugins/dashboard-menu-plugin-extensions).
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **Dashboard menu plugin:** Extend your Wix app's functionality by adding menu plugins to the user interfaces of an apps built by Wix. Learn more about [Dashboard menu plugin extensions](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/dashboard-extensions/dashboard-plugins/dashboard-menu-plugins/dashboard-menu-plugin-extensions).
- **Dashboard menu plugin:** Extend your Wix app's functionality by adding menu plugins to the user interface of an app built by Wix. Learn more about [Dashboard menu plugin extensions](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/dashboard-extensions/dashboard-plugins/dashboard-menu-plugins/dashboard-menu-plugin-extensions).

- **Backend API**: Define your own HTTP functions that can be called from your frontend code. Learn more about [Backend APIs](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/wix-cli/supported-extensions/backend-extensions/api/add-api-extensions-with-the-cli).
- **Dashboard modal:** Extend your Wix app's functionality by adding modals to your app's dashboard. Learn more about [Dashboard modals](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/wix-cli/supported-extensions/dashboard-extensions/dashboard-modals/add-dashboard-modal-extensions-with-the-cli).
- **Dashboard menu plugin:** Extend your Wix app's functionality by adding menu plugins to the user interfaces of an apps built by Wix. Learn more about [Dashboard menu plugin extensions](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/dashboard-extensions/dashboard-plugins/dashboard-menu-plugins/dashboard-menu-plugin-extensions).
- **WhatsApp integration:** Prepare personalized WhatsApp messages to customers from within your app.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prepare -> Send?


+ [Node.js](https://nodejs.org/en/) (v18.16.0 or higher)
+ [A Wix developer account](https://users.wix.com/signin?loginDialogContext=signup&referralInfo=HEADER&postLogin=https:%2F%2Fdev.wix.com%2Fdc3%2Fmy-apps&postSignUp=https:%2F%2Fdev.wix.com%2Fdc3%2Fmy-apps&forceRender=true)
+ A WhatsApp account.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
+ A WhatsApp account.
+ A WhatsApp account

Run the following command to create a new app project using this template:

```tsx
[fill this in]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't forget to add this


Run the following command to create a new app project using this template:

```tsx
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```tsx
```bash

## Available Scripts
In the creation process, you will be asked for:

+ A **Wix app name**. This is the name that appears for your app in the Wix Dev Center.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
+ A **Wix app name**. This is the name that appears for your app in the Wix Dev Center.
+ A **Wix app name**. This is the name that appears for your app in the App Dashboard.

It's no longer the Dev Center. Please fix all references to it.


Development entry point: [`template/src/dashboard/modals/sell-message-modal/modal.tsx`](./template/src/dashboard/modals/sell-message-modal/modal.tsx)

### Customize the WhatsApp integration
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe the heading should be "Customize the messaging integration", since the idea is that a dev can implement here any integration with any service they like?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants