|
| 1 | +# A CHANGEME-FRAMEWORK App Running On AWS Lambda |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | +## ✨ Quickstart |
| 6 | + |
| 7 | +Run the following command to create your own copy of this application: |
| 8 | + |
| 9 | +```bash |
| 10 | +npx scaffoldly create app --template CHANGEME-BRANCHNAME |
| 11 | +``` |
| 12 | + |
| 13 | +## Manual Setup |
| 14 | + |
| 15 | +This application was generated with the following command: |
| 16 | + |
| 17 | +```bash |
| 18 | +CHANGEME-CREATECOMMAND |
| 19 | +``` |
| 20 | + |
| 21 | +✨ No modifications or SDKs were made or added to the code to "make it work" in AWS Lambda. |
| 22 | + |
| 23 | +Check out our other [examples](https://github.com/scaffoldly/scaffoldly-examples) and Learn more at [scaffoldly.dev](https://scaffoldly.dev)! |
| 24 | + |
| 25 | +### Working example |
| 26 | + |
| 27 | +[CHANGEME-URL](CHANGEME-URL) |
| 28 | + |
| 29 | +## First, Scaffoldly Config was added... |
| 30 | + |
| 31 | +In the project's [`CHANGEME-CONFIGFILE`](CHANGEME-CONFIGFILE) file, the `scaffoldly` configuration was added: |
| 32 | + |
| 33 | +- Note 1 |
| 34 | +- Note 2 |
| 35 | + |
| 36 | +``` |
| 37 | +CHANGEME-CONFIG |
| 38 | +``` |
| 39 | + |
| 40 | +See the [Scaffoldly Docs](https://scaffoldly.dev/docs/config/) for additional configuration directives. |
| 41 | + |
| 42 | +## Then, deployed to AWS Lambda |
| 43 | + |
| 44 | +```bash |
| 45 | +npx scaffoldly deploy |
| 46 | +``` |
| 47 | + |
| 48 | +See the [Scaffoldly Docs](https://scaffoldly.dev/docs/cli/#scaffoldly-deploy) for details on the `scaffoldly deploy` command. |
| 49 | + |
| 50 | +### After deploy the app is available on a public URL |
| 51 | + |
| 52 | +```bash |
| 53 | +🚀 Deployment Complete! |
| 54 | + 🆔 App Identity: CHANGEME-IDENTITY |
| 55 | + 📄 Env Files: .env.main, .env |
| 56 | + 📦 Image Size: CHANGEME-IMAGESIZE MB |
| 57 | + 🌎 URL: CHANGEME-URL |
| 58 | +``` |
| 59 | + |
| 60 | +## GitHub Action added for CI/CD |
| 61 | + |
| 62 | +A [`scaffoldly.yml`](.github/workflows/scaffoldly.yml) was added to `.github/workflows` so that a push will trigger a deploy |
| 63 | + |
| 64 | +``` |
| 65 | +name: Scaffoldly Deploy |
| 66 | +
|
| 67 | +# ... snip ... |
| 68 | +
|
| 69 | +jobs: |
| 70 | + deploy: |
| 71 | + runs-on: ubuntu-latest |
| 72 | + steps: |
| 73 | + - name: Checkout |
| 74 | + uses: actions/checkout@v4 |
| 75 | +
|
| 76 | + - name: Deploy |
| 77 | + uses: scaffoldly/scaffoldly@v1 |
| 78 | + with: |
| 79 | + secrets: ${{ toJSON(secrets) }} |
| 80 | +``` |
| 81 | + |
| 82 | +See the [Scaffoldly Docs](https://scaffoldly.dev/docs/gha/) for additional GitHub Actions directives. |
| 83 | + |
| 84 | +## Questions, Feedback, and Help |
| 85 | + |
| 86 | +Join our [Discussions](https://github.com/scaffoldly/scaffoldly/discussions) on GitHub. |
| 87 | +Join our [Community](https://scaffoldly.dev/community) on Discord. |
| 88 | + |
| 89 | +## License |
| 90 | + |
| 91 | +This code is licensed under the [Apache-2.0](LICENSE.md) license. |
| 92 | + |
| 93 | +The [`scaffoldly`](https://github.com/scaffoldly/scaffoldly) toolchain is licensed under the [FSL-1.1-Apache-2.0](https://github.com/scaffoldly/scaffoldly?tab=License-1-ov-file) license. |
| 94 | + |
| 95 | +Copyright 2024 Scaffoldly LLC |
0 commit comments