|
| 1 | +# AWS Starter React for GitHub Actions |
| 2 | + |
| 3 | +This starter template contains a bootstrapped [Create React App](https://github.com/facebook/create-react-app) with a GitHub Workflow that deploys the app to the [AWS Amplify Console](https://aws.amazon.com/amplify/console/) using the [AWS CloudFormation Action for GitHub Actions](https://github.com/marketplace/actions/aws-cloudformation-deploy-cloudformation-stack-action-for-github-actions). |
| 4 | + |
| 5 | +## Create a new repository from this template |
| 6 | + |
| 7 | +Click the **Use this template** button above to create a new repository from this template. |
| 8 | + |
| 9 | +> This repository uses the new [template feature](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-template-repository) of GitHub. |
| 10 | +
|
| 11 | +You need your own AWS account to deploy the app to the [AWS Amplify Console](https://aws.amazon.com/amplify/console/). Follow these [steps](https://aws.amazon.com/premiumsupport/knowledge-center/create-and-activate-aws-account/) if you do not have an account. |
| 12 | + |
| 13 | +The AWS CloudFormation stack is deployed via [AWS CloudFormation "Deploy CloudFormation Stack" Action for GitHub Actions](https://github.com/marketplace/actions/aws-cloudformation-deploy-cloudformation-stack-action-for-github-actions). |
| 14 | + |
| 15 | +When you create a new repository from the template, the GitHub Workflow is not setup. To setup the workflow, you need to follow these steps. |
| 16 | + |
| 17 | +1. Create a [new personal token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) with **full control of private repositories** store it as [encrypted secret](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) `AMPLIFY_TOKEN` in the new repository. |
| 18 | +2. Create a [new IAM user in your AWS account](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html) with **Programmatic Access** and store the access key ID as `AWS_ACCESS_KEY_ID` and secret access key as `AWS_SECRET_ACCESS_KEY` as secrets in your new repository. |
| 19 | +3. (Optional) Configure a [custom domain](https://docs.aws.amazon.com/amplify/latest/userguide/custom-domains.html) for your app by setting the `AMPLIFY_DOMAIN` secret. |
| 20 | + |
| 21 | +If you are ready, either make a new change an push it, or *re-run* the [failed GitHub Workflow](https://help.github.com/en/actions/configuring-and-managing-workflows/managing-a-workflow-run). |
| 22 | + |
| 23 | +Because the first time the app gets deployed to the AWS Amplify Console it is not fully configured, you need to trigger a first manual build. Go to the [AWS Amplify Console](https://console.aws.amazon.com/amplify) and select your app from the list of all apps. |
| 24 | + |
| 25 | +You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. In the frontend environments is should show no builds. Click on **Run Build** to initialize the app. |
| 26 | + |
| 27 | +> The stack is deployed to `us-east-1` by default. Please change the region in the `.github/workflows/deploy.yaml` if you want to use a different one. |
| 28 | +
|
| 29 | +## Available Scripts |
| 30 | + |
| 31 | +In the project directory, you can run: |
| 32 | + |
| 33 | +### `yarn start` |
| 34 | + |
| 35 | +Runs the app in the development mode.<br /> |
| 36 | +Open [http://localhost:3000](http://localhost:3000) to view it in the browser. |
| 37 | + |
| 38 | +The page will reload if you make edits.<br /> |
| 39 | +You will also see any lint errors in the console. |
| 40 | + |
| 41 | +### `yarn test` |
| 42 | + |
| 43 | +Launches the test runner in the interactive watch mode.<br /> |
| 44 | +See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. |
| 45 | + |
| 46 | +### `yarn build` |
| 47 | + |
| 48 | +Builds the app for production to the `build` folder.<br /> |
| 49 | +It correctly bundles React in production mode and optimizes the build for the best performance. |
| 50 | + |
| 51 | +The build is minified and the filenames include the hashes.<br /> |
| 52 | +Your app is ready to be deployed! |
| 53 | + |
| 54 | +See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. |
| 55 | + |
| 56 | +### `yarn eject` |
| 57 | + |
| 58 | +**Note: this is a one-way operation. Once you `eject`, you can’t go back!** |
| 59 | + |
| 60 | +If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. |
| 61 | + |
| 62 | +Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. |
| 63 | + |
| 64 | +## Learn More |
| 65 | + |
| 66 | +You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). |
| 67 | + |
| 68 | +To learn React, check out the [React documentation](https://reactjs.org/). |
| 69 | + |
| 70 | +## License |
| 71 | + |
| 72 | +This library is licensed under the MIT-0 License. See the LICENSE file. |
0 commit comments