vaticle / typedb-studio

TypeDB Studio (IDE)
https://typedb.com
Mozilla Public License 2.0
186 stars 43 forks source link

Welcome screen and quickstart wizards in the Studio #745

Open izmalk opened 1 year ago

izmalk commented 1 year ago

Problem to Solve

When you open TypeDB Studio the first time you have an empty screen, and you're unsure what to do with it.

Screenshot 2023-06-12 at 12 12 40

Current Workaround

To manually select a folder (we have little info about how it will be used), manually select connection settings, click connect, and only then proceed to select database. The only tip on how to proceed is all the inactive buttons greyed out.

Proposed Solution

Would be nice to have a greeting (welcome screen) for a user, inviting him to different options:

  1. New project (wizard goes through creating a new Project folder, connecting to a server, and creating a database).
  2. Open project (wizard goes through opening a Project folder, connecting to a server, and choosing/creating a database).
  3. Open an example project (select an example from our typedb-examples repo, it will be downloaded and unzipped into a new folder, which will be set as a Project folder, select a server to connect, a new database will be created, schema uploaded).
  4. Close the welcome screen and continue manually setting things up.

Options 1-3 could have every stage described in the GUI with some proper options to select from or edit. Option №3 will create a new faster way to explore TypeDB through some pre-existing examples.

Additional Information

An alternative solution to go is to create a Tutorial with animation, highlights, and some tip popups to go through connecting to a database and selecting a Project folder.

izmalk commented 5 months ago
Screenshot 2024-01-23 at 19 22 11

An example of a Welcome screen from VS:Code