Skip to content

ARC 2256 - Enable user to see the basic skeleton of new config experience #2216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Jul 4, 2023

Conversation

krazziekay
Copy link
Collaborator

@krazziekay krazziekay commented Jul 3, 2023

What's in this PR?

  • Basic skeleton for the new config experience
  • Setup for React SPA
    • Local Proxy server setup for hot live reload
    • Production build setup
    • Dummy React component added, using AtlasKit button
    • ViteJs configured for bundling
    • New route added in atlassian-connect.json for loading React SPA pages.

Why

  • For setup of the 5KU first phase.

How has this been tested?

  • Locally
    • Simply run the github app, using the command yarn start, then the SPA can be viewed at URL https://ATLASSIAN-INSTANCE.net/spa-index-page

Whats Next?

  • Adding test cases

@krazziekay krazziekay requested a review from a team as a code owner July 3, 2023 05:46
@krazziekay krazziekay self-assigned this Jul 3, 2023
@krazziekay krazziekay requested review from gxueatlassian and removed request for gxueatlassian July 3, 2023 05:49
package.json Outdated
"start:main": "tsnd -r tsconfig-paths/register --watch=.env*,db/config.json --inspect=0.0.0.0:9229 --respawn --transpile-only -- src/main.ts",
"start:worker": "tsnd -r tsconfig-paths/register --watch=.env*,db/config.json --inspect=0.0.0.0:9230 --respawn --transpile-only -- src/worker.ts",
"start:production": "run-p start:main:production start:worker:production",
"start:production": "run-p spa:production start:main:production start:worker:production",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

spa:production should not be here, as in production, we don't need it it. We should copy the compiled assets during build time not run time.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

spa:production removed and added this step in build

@@ -0,0 +1,30 @@
{
"name": "spa",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe not matter, but anyway update the name as well;

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couldn't think of a better name, so keeping it as it is for now

@@ -0,0 +1,26 @@
{
"compilerOptions": {
"target": "ES2020",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/nit
might need put some comments somewhere to justify this.

*/
export default defineConfig({
plugins: [react()],
base: "/spa"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall we use something like /app instead of /spa, as /spa is quite technical details, and /app is more generic.

- Setup for Prod
- Setup for Prod
@krazziekay krazziekay requested a review from gxueatlassian July 3, 2023 23:46
gxueatlassian
gxueatlassian previously approved these changes Jul 3, 2023
@krazziekay krazziekay merged commit bb0cba2 into main Jul 4, 2023
@krazziekay krazziekay deleted the ARC-2256 branch July 4, 2023 01:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants