-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #21 from olliethedev/feat/blog-plugin
Feat/blog plugin
- Loading branch information
Showing
9 changed files
with
82 additions
and
19 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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
{ | ||
"version": "1.1.17", | ||
"version": "1.1.18", | ||
"private": true, | ||
"workspaces": [ | ||
"./packages/*" | ||
|
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
2 changes: 1 addition & 1 deletion
2
packages/amplify-graphql-process-image-transformer/package.json
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
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 +1,46 @@ | ||
wip | ||
# Amplify Util Blog | ||
|
||
Amplify Util Blog is a utility plugin for the Amplify CLI that helps you add blog functionality to your Amplify project. It provides commands to add and remove blog related resources, and it also updates your GraphQL schema, parameters, transformer configuration, and UI elements to support blog features. | ||
|
||
## Features | ||
|
||
- Adds Post and Tag models to your GraphQL schema. | ||
- Adds blog related UI components to your project. | ||
- Updates parameters configuration with Typesense related parameters to enable search. | ||
- Updates transformer configuration to include `amplify-graphql-typesense-transformer` to enable search. | ||
- Supports only JavaScript/TypeScript React projects. | ||
|
||
## Commands | ||
|
||
- `version`: Displays the version of the plugin. | ||
- `help`: Provides help information for the plugin. | ||
- `add`: Adds blog related resources to your project. | ||
- `remove`: Removes blog related resources from your project. | ||
|
||
|
||
## Installation | ||
|
||
To use this plugin, you need to install it globally: | ||
```bash | ||
npm install -g @amplifiers/amplify-util-blog | ||
``` | ||
|
||
Then, you can use the `amplify plugin add` command to add it to your Amplify CLI: | ||
```bash | ||
amplify plugin add /usr/local/lib/node_modules/@amplifiers/amplify-util-blog | ||
``` | ||
|
||
Follow the prompts to add the `amplify-util-blog` plugin. | ||
|
||
## Usage | ||
|
||
To add blog functionality to your project, run: | ||
```bash | ||
amplify amplify-util-blog add | ||
``` | ||
|
||
To remove blog functionality from your project, run: | ||
```bash | ||
amplify amplify-util-blog remove | ||
``` | ||
|
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