diff --git a/Readme.md b/Readme.md index a918bcb01f..d6df3385cf 100644 --- a/Readme.md +++ b/Readme.md @@ -6,9 +6,6 @@ Discord Chat - - - build:started @@ -18,74 +15,45 @@ [![Open Bugs](https://img.shields.io/github/issues/aws-amplify/amplify-category-api/bug?color=d73a4a&label=bugs)](https://github.com/aws-amplify/amplify-category-api/issues?q=is%3Aissue+is%3Aopen+label%3Abug) [![Feature Requests](https://img.shields.io/github/issues/aws-amplify/amplify-category-api/feature-request?color=ff9001&label=feature%20requests)](https://github.com/aws-amplify/amplify-category-api/issues?q=is%3Aissue+label%3Afeature-request+is%3Aopen) -[![Enhancements](https://img.shields.io/github/issues/aws-amplify/amplify-category-api/enhancement?color=4287f5&label=enhancement)](https://github.com/aws-amplify/amplify-category-api/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) [![Closed Issues](https://img.shields.io/github/issues-closed/aws-amplify/amplify-category-api?color=%2325CC00&label=issues%20closed)](https://github.com/aws-amplify/amplify-category-api/issues?q=is%3Aissue+is%3Aclosed+) -# AWS Amplify API Category - -The AWS Amplify CLI is a toolchain which includes a robust feature set for simplifying mobile and web application development. The CLI uses AWS CloudFormation and nested stacks to allow you to add or modify configurations locally before you push them for execution in your account. - -- [Install the CLI](#install-the-cli) -- [Tutorials](#tutorials) -- [Contributing](#contributing) -- [Changelog](https://github.com/aws-amplify/amplify-category-api/releases/latest) - -This repo manages the API category within Amplify CLI. The Category is responsible for managing graphql build and transformation processes, generating resources to deploy into your cloud stack in order to compute and store data for your graphql and REST endpoints, and providing inputs to codegen processes for use later in your end application. +# AWS Amplify Gen 2 Data -## Install the CLI +This next generation of Amplify’s backend building experience lets you author your frontend and backend definition completely with TypeScript, a file convention, and Git branch-based environments. To learn more, visit [AWS Amplify Gen 2](https://docs.amplify.aws). -- Requires Node.js® version 18 or later +This repo manages the data within Amplify. Data is responsible for managing graphql build and transformation processes, generating resources to deploy into your cloud stack in order to compute and store data for your graphql and REST endpoints, and providing inputs to codegen processes for use later in your end application. -Install and configure the Amplify CLI as follows: - -```bash -$ npm install -g @aws-amplify/cli -$ amplify configure -``` +## Quickstart -**_Note_**: If you're having permission issues on your system installing the CLI, please try the following command: +To get started with Amplify Gen 2, visit [AWS Amplify Gen 2 Quickstart](https://docs.amplify.aws/react/start). ```bash -$ sudo npm install -g @aws-amplify/cli --unsafe-perm=true -$ amplify configure +npm create amplify@latest ``` -### Category specific commands: - -The following table lists the current set of commands supported by the Amplify API Category Plugin. - -| Command | Description | -| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| amplify api add | Takes you through steps in the CLI to add an API resource to your backend. | -| amplify api add-graphql-datasource | Takes you through the steps in the CLI to import an already existing Aurora Serverless data source to an existing GraphQL API resource. | -| amplify api update | Takes you through steps in the CLI to update an API resource. | -| amplify api gql-compile | Compiles your GraphQL schema and generates a corresponding cloudformation template. | -| amplify api push | Provisions only API cloud resources with the latest local developments. | -| amplify api remove | Removes an API resource from your local backend. The resource is removed from the cloud on the next push command. | - ## Tutorials - [Getting Started guide](https://docs.amplify.aws/start) -- [GraphQL transform tutorial](https://docs.amplify.aws/cli/graphql-transformer/overview) +- [Setup data](https://docs.amplify.aws/react/build-a-backend/data/set-up-data/) -## Developing +## Security -To set up your local development environment, go to [Local Environment Setup](https://github.com/aws-amplify/amplify-category-api/blob/main/CONTRIBUTING.md#local-environment-setup). +If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue. -To test your category, do the following: +## Code of Conduct -```sh -cd -amplify-dev init -amplify-dev -``` +This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). +For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact +opensource-codeofconduct@amazon.com with any additional questions or comments. -Before pushing code or sending a pull request, do the following: +## Community -- At the command line, run `yarn lint` at the top-level directory. This invokes eslint to check for lint errors in all of our packages. -- You can use `yarn lint` to find some of the lint errors. To attempt fix them, go to the package that has errors and run `yarn lint-fix` -- If there are any remaining lint errors, resolve them manually. Linting your code is a best practice that ensures good code quality so it's important that you don't skip this step. +Join the [Discord Server](https://discord.com/invite/amplify). ## Contributing We are thankful for any contributions from the community. Look at our [Contribution Guidelines](https://github.com/aws-amplify/amplify-category-api/blob/main/CONTRIBUTING.md). + +## License + +This project is licensed under the Apache-2.0 License.