✅ - Using Amplify in an Open Source project

[hollow rivet]

I couldn't find information on the best practices for building an open source project using Amplify.

What I want is to create an open source project that people who fork the repo can then deploy on to their own Amplify accounts. What's the best practice to do so? Simply not commit the amplify_outputs.json to the repo?

[calm vault]

hey, yes you shouldnt need to typically commit your amplify_outputs unless you need to reuse a backend env in a different app
but other than the outputs file i would also check for any resources that may be account dependent such as references resource or any secrets hardcoded in the project

[hollow rivet]

Thanks! Do you mean any ARNs that could be hardcoded? Makes sense.

[calm vault]

not just arn but also any actual api keys or secrets in your frontend library
other example would be lambda layer that exists only in your account etc

while its typically not best practise to paste Arns publicly it should be fine as the resource are typically behind IAM creds which absolutely should not be shared

[tepid vault]

✅ - Using Amplify in an Open Source project