Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Complete re-introduction of Telestion Client #194

Merged
merged 257 commits into from
Jan 26, 2021
Merged

Complete re-introduction of Telestion Client #194

merged 257 commits into from
Jan 26, 2021

Conversation

fussel178
Copy link
Member

@fussel178 fussel178 commented Jan 2, 2021 •
edited
Loading

Abstract

This is a complete re-introduction of the Telestion Client.
The Telestion Frontend is now structured in different packages installable via your favorite package manager.
Every package fulfills an important part in the Telestion Client ecosystem:

package role
@wuespace/vertx-event-bus The connection interface which transports event bus messages between the frontend and the backend
@wuespace/telestion-client-types Essential TypeScript types of the Telestion Client
@wuespace/telestion-client-prop-types prop-types of types important for the Telestion Client React components
@wuespace/telestion-client-core The core part of the application. It offers an interface for the mandatory parts of the Telestion Client like managing the authencation and eventbus connection with the backend. It defines the structure of the application.
@wuespace/telestion-client-common The "extension" of the core part. If offers an interface for the most common parts of Telestion Client including Adobe React Spectrum Design components and "nice-to-have" React hooks and components.
@wuespace/telestion-client-cli A command-line interface for Telestion Client projects. It can create, manage and deploy Telestion Client via a user friendly CLI.
@wuespace/telestion-client-template A template for a ready-to-start project using Telestion Client.
@wuespace/mock-server A mock server for the event bus connection and authentication.

Changes

  • restructured as monorepo managed with lerna
  • new packager for library components in the different packages with rollup
  • complete refactoring of every written file and file system structure
  • full TypeScript support
  • extensive documentation (coming soon™)
  • tests of all different kinds (unit, integration, end-2-end)
  • Storybook stories for every important component to see its usage in action

(Mostly) Required Steps 😉

  • Implementation
    • vertx-event-bus
    • types
      • Page Functional Component
      • User Config
      • Widget
    • prop-types
    • core
      • components
      • hooks
      • libraries
    • common
      • components
      • widgets
      • hooks
      • libraries?
    • cli
      • init
      • start
      • build
      • generate
      • doc
      • stats
    • mock-server
    • template
  • Tests (Unit, Integration, E2E)
    • vertx-event-bus
    • types
    • prop-types
    • core
      • components
      • hooks
      • (libraries)
    • common
      • components
      • widgets
      • hooks
      • (libraries?)
    • cli
      • init
      • start
      • build
      • generate
      • doc
      • stats
    • mock-server
    • template (build and test generated project)
  • TypeScript Support
    • vertx-event-bus
    • types
    • prop-types
    • core
      • components
      • hooks
      • libraries
    • common
      • components
      • widgets
      • hooks
      • libraries?
    • mock-server
  • Documentation
    • core
    • common
    • cli
    • mock-server
  • Building
    • vertx-event-bus (rollup)
    • types (tsc)
    • prop-types (rollup)
    • core (rollup)
    • common (rollup)
    • cli (none)
    • mock-server (rollup)
  • ESLint
    • vertx-event-bus
    • types
    • prop-types
    • core
    • common
    • cli
    • mock-server
  • Code Documentation
    • vertx-event-bus
    • types
      • Page Functional Component
      • User Config
      • Widget
    • prop-types
    • core
    • common
    • cli (not required)
    • mock-server
  • Misc
    • GitHub Actions for automatic deployment
    • READMEs
      • vertx-event-bus
      • types
      • prop-types
      • core
      • common
      • cli
      • mock-server
    • package.json
      • vertx-event-bus
      • types
      • prop-types
      • core
      • common
      • cli
      • mock-server

Things to do before merge:

  • Add LICENSE
  • Change actions trigger in .github/workflows/docs.yml to main
  • Change actions trigger in .github/workflows/codeql-analysis.yml to main
  • Change actions trigger in .github/workflows/shiftleft-analysis.yml to main

fixes #155

fussel178 and others added 20 commits December 2, 2020 01:06
@fussel178
style: Fixed styling
cbe104e
@fussel178
feat(core): Changed type of component to React functional component
33a1390
@fussel178
fix: dependencies and cleaned up some scripts
3bf2235
@fussel178
build: rollup now minifies the generated builds with terser
93f46b6
@fussel178
fix: changed life cycle script prepublish to prepublishOnly
a78e4f9
@fussel178
feat(ci): Added github actions continuous integration workflow
dc15150
@fussel178
fix(ci): github actions ci workflow
e14d104
@fussel178
fix(ci): added lerna install to ci workflow
16ff9e2
@fussel178
fix(style): Fixed styling with prettier
d6e80f4
@fussel178
fix(types): Build packages in dependency order
d049db8
@fussel178
feat(cli): Finalized init implementation (test needed)
55f5c95
@fussel178
chore(dep): Fixed 15 low severity vulnerabilities with npm
d05d849
@fussel178 @pklaschka
feat(core): First structuring and implementation
8fa47ad 
- compound components
- app pages with react-router
- custom stateful hooks with zustand:
    - authentication hook
    - eventbus hook
- Fake authentication
- vert.x eventbus fixes:
    - registration and message now possible on closed state
- full TypeScript support

Co-authored-by: pklaschka <contact@pabloklaschka.de>
@fussel178 @pklaschka
feat(common): First structuring and implementation
ef4e096 
- some basic context and hooks
- types for widget

Co-authored-by: pklaschka <contact@pabloklaschka.de>
@fussel178
feat(common): Implementation of eventbus abstraction hooks
e9079a8 
- fixed styling issues
@fussel178
fix(build): Build dependencies in rollup and module resolution
f1b405c
@fussel178
feat(core): Implementation usePreferences hook
9f3e7cc
@fussel178
docs(core): Cleanup of documentation
4c69e3c
@fussel178
fix(build): rollup config imports
bdc8a9a
@fussel178
feat(core): Implementation of title preference in TelestionClient com…
629774c 
…ponent
@fussel178 fussel178 added 📚 documentation Improvements or additions to documentation 🔨 enhancement New feature or request 👓 tests Tests for the project labels Jan 2, 2021
@fussel178 fussel178 self-assigned this Jan 2, 2021
@pklaschka pklaschka self-requested a review January 26, 2021 00:28
pklaschka
pklaschka previously approved these changes Jan 26, 2021
View reviewed changes
@fussel178 fussel178 changed the title WIP: Complete re-introduction of Telestion Client Complete re-introduction of Telestion Client Jan 26, 2021
@fussel178
chore: Change lerna allow branch to main branch
25a6d37
@fussel178
chore(ci): Change actions trigger branches to main
0d678c3
@fussel178
Merge branch 'main' into monorepo
4e4c281 
# Conflicts:
#	.github/workflows/ci.yml
#	.github/workflows/cypress.yml
#	.github/workflows/release.yml
#	package-lock.json
#	package.json
@fussel178 fussel178 merged commit 5e4c025 into main Jan 26, 2021
@fussel178 fussel178 deleted the monorepo branch January 26, 2021 02:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pklaschka pklaschka pklaschka approved these changes

Assignees

@fussel178 fussel178

Labels
📚 documentation Improvements or additions to documentation 👓 tests Tests for the project 🔨 enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Caching in Github workflows
2 participants
@fussel178 @pklaschka