wuespace / telestion-client

Telestion Frontend Framework (Technical leads: Ludwig Richter, Jan Tischhöfer)

https://telestion.wuespace.de

MIT License

7 stars 1 forks source link

Support for new template-telestion-application #518

Closed fussel178 closed 3 years ago

fussel178 commented 3 years ago

Feature Request

Summary

Add support for the new directory structure in the template-telestion-application.

Details

As described below, things we need to do in the CLI:

[ ] Detect the core and gui/README.md folder structure. (a simple "directory exists" check should suffice)
[ ] Delete the gui/README.md.
[ ] Copy the template files into the guidirectory.
[ ] Change directory into the gui folder.
[ ] Do the rest of the initialization steps. (Install development dependencies, ...)
[ ] Skip the git init step.
[ ] Change the commit message to feat: Initialized Telestion Frontend (or something else)

pklaschka commented 3 years ago

What should the CLI do there? Generate the "whole" repository? Detect the structure and generate the PSC without git actions into ./gui?

fussel178 commented 3 years ago

The CLI should the detect the "special" directory structure of the telestion-template and should initialize the PSC inside the gui folder, and it should skip the git init step. Otherwise the same behaviour as currently implemented.

The "new" initialization steps, as discussed with @jvpichowski, are:

Clone the https://github.com/TelestionTeam/template-telestion-application template repository.
Initialize the cloned repo with the steps described in the root README.md.

Now you have a "valid" Telestion application. Some projects do not need a client/frontend to interact with. If you need a client/frontend, then:

Initialize the client/frontend in the gui folder by following the steps in the gui/README.md. These steps are installing node and npm and simply calling tc-cli init on the root directory of the git repo.

Now you have a full blown Telestion application with app and client/frontend.

fussel178 commented 3 years ago

See above.

pklaschka commented 3 years ago

@jvpichowski @fussel178 Are we able to add some unique "identifier" file (e.g., with an "unusual" name) in the root of the template (or, possibly, into the GUI folder)? I'm reluctant to define any folder that contains a gui folder and a README.md as that structure 🤔.

Possibly:

telestion-project.txt

This file is used to detect the folder structure within our automation tools.

DO NOT EDIT, MOVE, RENAME, OR REMOVE this file, or our development automation tools might not work as expected

jvpichowski commented 3 years ago

I like the idea buT please don't name it .txt.

fussel178 commented 3 years ago

Then simply gui/telestion-project?

jvpichowski commented 3 years ago

Maybe gui/telestion-gui because the project is the whole or gui/telestion.gui and we would not need the gitkeep anymore in the gui folder

fussel178 commented 3 years ago

We finally found a solution and updated the template repository! https://github.com/wuespace/telestion-project-template

Please take a look at the new folder and file structure before taking further action.