|
1 | | -## SWA EMU: Azure Static Web Apps Emulator (Alpha Preview) |
| 1 | +<p align="center"> |
| 2 | + <h2 align="center">Azure Static Web Apps Emulator</h2> |
| 3 | +</p> |
| 4 | +<p align="center"> |
| 5 | + <img align="center" src="docs/swa-emu-icon.png" width="200"> |
| 6 | +</p> |
2 | 7 |
|
3 | | -SWA EMU serves as a local emulator for [Azure Static Web Apps](https://bit.ly/2ZNcakP). It can: |
| 8 | +Introducing SWA EMU, the Azure Static Web Apps Emulator that serves as a local emulator for [Azure Static Web Apps](https://bit.ly/2ZNcakP). It can: |
4 | 9 |
|
5 | 10 | - Auto-build your local APP and API |
6 | 11 | - Emulate Authentication |
@@ -31,7 +36,7 @@ The Authentication flow is illustrated in the following sequence diagram (or [op |
31 | 36 |
|
32 | 37 | ## Disclaimer |
33 | 38 |
|
34 | | -SWA EMU is still in alpha preview and not yet ready for prime time. You will encounter issues, so please report them or help us fix them. Your contributions will be very appreciated 🙏 |
| 39 | +SWA EMU is still in developer preview and not yet ready for prime time. You will encounter issues, so please report them or help us fix them. Your contributions will be very appreciated 🙏 |
35 | 40 |
|
36 | 41 | ## Quick start |
37 | 42 |
|
@@ -72,19 +77,19 @@ If you need to override the default values, provide the following options: |
72 | 77 |
|
73 | 78 | ## Auth emulation status |
74 | 79 |
|
75 | | -| Provider | Local Emulation | Linked OAuth App | |
76 | | -| -------- | --------------- | ---------------- | |
77 | | -| GitHub | ✅ | ✅ | |
78 | | -| Twitter | TODO | | |
79 | | -| Google | TODO | | |
80 | | -| Facebook | TODO | | |
81 | | -| AAD | TODO | | |
| 80 | +| Provider | Local Emulation | |
| 81 | +| -------- | --------------- | |
| 82 | +| GitHub | ✅ | |
| 83 | +| Twitter | ✅ | |
| 84 | +| Google | ✅ | |
| 85 | +| Facebook | ✅ | |
| 86 | +| AAD | ✅ | |
82 | 87 |
|
83 | 88 | ## Caveats |
84 | 89 |
|
85 | | -- Custom routes are not supported. |
86 | | -- Authorization and roles are not supported. |
87 | | -- The emulator is serving all traffic over HTTP (HTTPS support will be added soon). |
| 90 | +- Custom routes are not yet supported. |
| 91 | +- Authorization and roles are not supported (see [#7](https://github.com/manekinekko/swa-emulator/issues/7)). |
| 92 | +- The emulator is serving all traffic over HTTP (HTTPS support will be added soon) (see [#4](https://github.com/manekinekko/swa-emulator/issues/4)). |
88 | 93 | - When using GitHub, the OAuth client ID and client secret are provided as-is for dev purposes ONLY. You should create your own OAuth GitHub app! |
89 | 94 |
|
90 | 95 | ## Troubleshooting |
|
0 commit comments