Git Product home page Git Product logo

amplify-codegen's Introduction

AWS Amplify

Discord Chat build:started

Reporting Bugs/Feature Requests

Open Bugs Feature Requests Enhancements Closed Issues

Amplify Codegen

Amplify Codegen is a JavaScript toolkit library for frontend and mobile developers building amplify applications. Packages are mainly used for frontend code generation including:

Package Description
amplify-codegen Amplify plugin for code generation
appsync-modelgen-plugin Model generator for Amplify Datastore
graphql-docs-generator Generates statements from GraphQL schema
graphql-types-generator Generates type annotations from GraphQL schema and statements

Developing

This section should get you running with Amplify Codegen. You will need to set nodejs to a version less than v16 on your system. Developing locally also requires yarn.

Start by Forking the main branch of amplify-codegen.

$ git clone [email protected]:[username]/amplify-codegen.git
$ cd amplify-codegen

$ yarn setup-dev

To generate model files in an Amplify app using the local version of codegen, run amplify-dev codegen models in an Amplify app.

Before pushing code or sending a pull request, do the following:

  • At the command line, run npm run lint at the top-level directory. This invokes lerna to check for lint errors in all of our packages.
  • You can use eslint to fix some of the lint errors. To use it, go to the package that has errors and run 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.

Troubleshooting

Errors sometimes occur when a different version of amplify-cli-core is installed, typically during the time the CLI is updated. To resolve the error, execute the following command from the top-level directory:

rm -rf yarn.lock && yarn clean && yarn setup-dev

Contributing

See the contribution guideline. https://github.com/aws-amplify/amplify-codegen/blob/main/CONTRIBUTING.md

amplify-codegen's People

Contributors

aaronzylee avatar akgm3i avatar akshbhu avatar alharris-at avatar ammarkarachi avatar arlen22 avatar attilah avatar david-mcafee avatar diegocstn avatar dpilch avatar edwardfoyle avatar frimfram avatar hirochachacha avatar huisf avatar jamesonwilliams avatar jordan-nelson avatar kaustavghosh06 avatar lawmicha avatar lazpavel avatar marcvberg avatar mikepschneider avatar nikhname avatar phani-srikar avatar rakannimer avatar seang96 avatar siegerts avatar sundersc avatar swaysway avatar unleashedmind avatar yuth avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.