This repository was archived by the owner on Jun 1, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 206
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README and links for Shopify App CLI (#1061)
* update readme * add link * delete docs folder and update links to point to shopify.dev * link fix * wording tweaks * set up redirect to shopify.dev * Redirects for deep links * minor tweaks * rubocop error fixes
- Loading branch information
Showing
46 changed files
with
228 additions
and
1,570 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 |
---|---|---|
@@ -1,13 +1,45 @@ | ||
# Shopify App CLI | ||
# [Shopify App CLI](https://shopify.dev/tools/cli) | ||
|
||
[](LICENSE.md)[](https://travis-ci.com/Shopify/shopify-app-cli) | ||
|
||
Shopify App CLI helps you build Shopify apps faster. It automates many common tasks in the development process and lets you quickly add popular features, such as billing and webhooks. | ||
Shopify App CLI helps you build Shopify apps faster. It quickly generates Node.js and Ruby on Rails apps and automates many common development tasks. | ||
|
||
## Using the CLI | ||
Consult the [Shopify App CLI documentation](https://shopify.github.io/shopify-app-cli) to get started. | ||
## Features | ||
|
||
## Developing the CLI | ||
This is an [open-source](https://github.com/Shopify/shopify-app-cli/blob/master/.github/LICENSE.md) tool and developers are [invited to contribute](https://github.com/Shopify/shopify-app-cli/blob/master/.github/CONTRIBUTING.md) to it. Please check the [code of conduct](https://github.com/Shopify/shopify-app-cli/blob/master/.github/CODE_OF_CONDUCT.md) before you begin. | ||
Shopify App CLI helps your app development process in the following ways: | ||
|
||
[Read the development guide](https://github.com/Shopify/shopify-app-cli/wiki) to learn more. | ||
- Creates an app in the [Partner dashboard](https://partners.shopify.com/current/resources) | ||
- Populates test data for your app, including products, customers, and draft orders | ||
- Generates new [webhooks](https://shopify.dev/tutorials/manage-webhooks) for your app | ||
- Deploys your app to an external platform, such as [Heroku](https://www.heroku.com/) | ||
|
||
## Installation | ||
|
||
Refer to [*Install Shopify App CLI*](https://shopify.dev/tools/cli/installation) to learn how to install Shopify App CLI on Windows, macOS, or Linux. | ||
|
||
## Getting started | ||
|
||
Refer to [*Getting started with Shopify App CLI*](https://shopify.dev/tools/cli/getting-started) to learn how to create and manage different types of projects with Shopify App CLI. | ||
|
||
## References | ||
|
||
- **[Shopify App CLI core commands](https://shopify.dev/tools/cli/reference)** - A complete reference of core commands for Shopify App CLI. | ||
- **[Node.js app commands](https://shopify.dev/tools/cli/reference/node-app)** - A complete Shopify App CLI command reference for Node.js apps. | ||
- **[Ruby on Rails app commands](https://shopify.dev/tools/cli/reference/ruby-on-rails-app)** - A complete Shopify App CLI command reference for Ruby on Rails apps. | ||
|
||
## Troubleshooting | ||
|
||
Refer to [*Troubleshooting Shopify App CLI*](https://shopify.dev/tools/cli/troubleshooting) to learn how to upgrade, migrate from a legacy version, and uninstall Shopify App CLI. | ||
|
||
## Contributing to Shopify App CLI | ||
|
||
Shopify App CLI is an [open source](https://github.com/Shopify/shopify-app-cli/blob/master/.github/LICENSE.md) tool and you can [help contribute to the GitHub repository](https://github.com/Shopify/shopify-app-cli/blob/master/.github/CONTRIBUTING.md). | ||
|
||
## Developing Shopify App CLI | ||
|
||
Read the [development guide](https://github.com/Shopify/shopify-app-cli/wiki). | ||
|
||
## Where to get help | ||
|
||
- **[Open a GitHub issue](https://github.com/Shopify/shopify-app-cli/issues)** - To report bugs or request new features, open an issue in the Shopify App CLI repository. | ||
- **[Shopify Community Forums](https://community.shopify.com/)** - Visit our forums to connect with the community and learn more about Shopify App CLI development. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,2 @@ | ||
title: Shopify App CLI | ||
markdown: kramdown | ||
url: https://shopify.github.io | ||
baseurl: /shopify-app-cli | ||
|
||
exclude: [ | ||
'heroku/', | ||
'Gemfile', | ||
'Gemfile.lock' | ||
] | ||
|
||
defaults: | ||
- scope: | ||
path: "" | ||
values: | ||
toc: true | ||
|
||
plugins: | ||
- jekyll-redirect-from | ||
- jekyll-redirect-from |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.