Website architecture documentation #1199
Conversation
Signed-off-by: Peter Nied <[email protected]>
peternied
requested review from
AndreKurait,
chelma,
gregschohn,
lewijacn,
mikaylathompson and
sumobrian
as code owners
peternied
had a problem deploying
to
migrations-cicd
GitHub Actions
Failure
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1199 +/- ##
=========================================
Coverage 80.39% 80.39%
Complexity 3094 3094
=========================================
Files 424 424
Lines 15742 15742
Branches 1066 1066
=========================================
Hits 12655 12655
Misses 2435 2435
Partials 652 652
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
| *Local Dev* | ||
|
|
||
| Next.js comes with a [dev webserver](https://nextjs.org/docs/app/api-reference/cli/next#next-dev-options) that runs all pages as part of a sever-side website. While this is slightly different experience from the static workflow writing code and seeing an update to the UX occurs in sub-second time frame - perfect for quickly iterating on layout and routing logic. |
There was a problem hiding this comment.
What would the testing cycle look like then to see a change on the UI locally when developing? In the past when working with React it has been nice to make a change and see the UI get updated rapidly
There was a problem hiding this comment.
💯 We are going to use npm run dev to spin up a local webserver that dynamically updates, its v. fast
| *Linting* | ||
|
|
||
| Linters will be enforced for best practice management and code styling. All website components will follow these tooling that are available through NPM. Next.js has [default conventions](https://nextjs.org/docs/app/api-reference/config/eslint) for both eslint and prettier and we will enable them in our CI workflows. |
There was a problem hiding this comment.
Will this linting be in-line with the linting our CDK uses?
There was a problem hiding this comment.
We will keep using eslist. I am adding Prettier, this won't impact the npm run dev mode, build will check for style when files are imported. When these go in, or even later, we can tweak this setting as we come up with strong opinions on the TS style.
Description
Website architecture documentation
Issues Resolved
Testing
Prototype in progress in https://github.com/peternied/opensearch-migrations/tree/frontend-proto
Check List
New functionality includes testingPublic documentation issue/PR created, if applicable.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.