pocinnovation/dagviz

Visualize your Cue DAG

dagviz's Issues

[Feature]: Create a visualization of your JSON in Electron

Description

The main part of your app: DagViz 🚀

Expected behaviour

• Visualize your JSON using Mermaid
• Implement simple interactions to make it dynamic: zoom, movements...

Environment

/

Proposed solution

/

[Feature]: Dag skills development

Description

Learn what a DAG is and how to use it 🚀

Expected behaviour

Here what you have to do :

• Read this Wikipedia article
• Read this introduction to DAG
• Create a DAG using Golang
  EDIT :
  Create an acyclic linked list composed of interfaces. Your free to decide what they are made of.

Display the Dag in a nice way in the terminal

• Create a PoC Rump about DAGs

Use this template

• Put it in PoC's drive

Useful links :

• Golang dag package
  EDIT :
  Do not use it

Environment

/

Proposed solution

/

[Feature]: Add some interactivity to your app

Description

Visualization is great, but a great UX is better 🤩

Expected behaviour

• Add a simple sidebar menu with details (filename, settings...)
• Create simple settings (zoom level, max dependencies shown... implement features you find useful 😉 )
• Use your creativity and ask for user feedback to improve your app !

Environment

/

Proposed solution

No response

[Feature]: Open-Source skills development

Description

Learn how to work on an open-source project 🚀

Expected behaviour

Here is what you have to do :

• Create a project from PoC's project template and play with :

  • Milestones
  • Issues
  • Pull Requests
  • Releases
  • Labels
  • GitHub project (beta version)

• Update the README.md by replacing [PROJECT'S NAME] by DagViz, by filling Our PoC Team, ...

• Update the CONTRIBUTING.md file by replacing [PROJECT'S NAME] and $REPOSITORY with DagViz, ...

Environment

/

Proposed solution

/

[Feature]: Get ready to create your Electron app

Description

Learn how an Electron app can be created and be ready to start developing yours 🚀

Expected behaviour

• Wireframe your UI using any tool you want (figma, excalidraw...)
• Follow the official documentation to create a simple app

Environment

/

Proposed solution

/

[Feature]: Cue API skills development

Description

Learn how to interact with the Cue API 🚀

Expected behaviour

Here is what you have to do :

• Write a Golang program that take a simple Cue program as parameter, and returns any informations that you find useful (dependencies, ...) formated in a JSON file

Useful links :

• Golang API to interact with Cue programs

Environment

/

Proposed solution

/

[Feature]: Create a Dag from a Cue program

Description

Create a dag from a cue program 🚀

Here is the schema :

• With Cue API, you get informations about the given Cue program, as JSON
• With you custom Go Dag librairy, create a Dag from this JSON

Expected behaviour

Here is what you have to do :

• Update the documentation and the README.md
• Implement the feature
• Add unit-tests and functional tests
• Dockerize the project
• Ask Tom and Damien to review your code

Environment

/

Proposed solution

/

[Feature]: Add a great design !

Description

A working app to visualize your DAG with interactivity is cool, but a beautiful design is better !

Expected behaviour

• Select a UI library like Material or Chakra
• Design the tree with a custom font and/or icons 🚀
• Design the visualization part with great popups (and even custom buttons to perform actions like zoom or change the color)

Environment

/

Proposed solution

No response

[Feature]: Get ready to create your VSCode extension

Description

Learn how a VSCode extension can be created and be ready to start developing it 🚀

Expected behaviour

• Skills development in TypeScript: follow this course
• Wireframe your UI: you can use figma
• Follow the official documentation to create your first extension
• Check how a graphical VSCode extension is built: look at the code of Git Graph

Environment

/

Proposed solution

/

[Feature]: Add an optional JSON formatting

Description

Allow users to get an output in a standard JSON format 🚀

Expected behaviour

Add an optional flag for your Go program to output your result in a JSON file.
It will then be used in your UI, or directly by users to adapt it for their needs 🧠

Environment

/

Proposed solution

/

[Feature]: Cue skills development

Description

Learn Cue language 🚀

Expected behaviour

Here is what you have to do :

cuelang.org will be your best friend

Cuelang GitHub

• Read Cue introduction
• Read Cue use cases
• Read the logic of Cue
• Read Cue specifications
• Follow all the Cue tutorials
• Write a Cue program that validates GitHub Actions
• Call @TomChv to review your Cue program

Environment

/

Proposed solution

/

[Feature]: Golang skills development

Description

Learn Golang language 🚀

Expected behaviour

Here is what you have to do :

• Follow the entire Go Tour
• Follow this PoC's Golang course until step 9
• Follow this PoC's Gin course until step 9
• Read this Golang Interface article
• Read this Golang Data Structures article

Environment

/

Proposed solution

/