Project for Mike the intern

[alancleary]

The LIS team at NCGR has an intern - Mike (@ATintern). He'll be working on projects related to GCV this semester. Currently he's working on a couple small issues (#381 and #400) that will introduce him to the general organization of GCV in the context of GitHub, and then he'll be working on an epic (#401) that will give him a more in-depth look at GCV and its microservices. The epic is very hands-on because it's intended to introduce Mike to specific technical details of the GCV stack. After his Tour de GCV, though, I want Mike to work on something more self-directed.

We're still a few weeks out from Mike being ready for a self-directed project but I thought I would start a discussion now so there's time for input from anyone in the @legumeinfo group that cares to comment.

Here's a list of potential projects. I'll update it as other projects are suggested.

• Code linting/formatting
  • Microservices
    • Implement code linting/formatting on a per app or repository level (with Black?)
    • Automate linting/formatting in the repository with GitHub actions and/or workflows
  • Angular app
    • Implement code linting/formatting in the Angular app (with the eslint Angular plugin)
    • Automate linting/formatting in the repository with GitHub actions and/or workflows
• Testing
  • Microservices
    • Individual microservices need unit testing
    • Individual microservices need integration testing
    • Individual microservices need regression testing
    • Microservices that depend on each other need integration testing
    • Microservices that depend on each other need regression testing
  • Angular app
    • Individual pieces of code need unit testing
    • The angular app, modules, and components need integration testing
    • The angular app, modules, and components need regression testing
  • We need to curate a data set specifically for testing
• Angular app module
  • I'm not sure what functionality a new module in the GCV Angular app would actually introduce but this would be a crash course in Angular
• Web Components
  • Convert GCV D3 visualizations to Web Components
    • These would live in the LIS Web Components monorepo
    • Automating building and publish Web Components to NPM and/or the GitHub package registry (via Lerna or some other such tool)
• Code generation
  • The microservices support HTTP and gRPC requests. The gRPC client and server code is automatically generate from the protocol buffers that define the services. Conversely, the client and server code for HTTP requests is all coded by hand.
    • Implement generation of OpenAPI specifications from protocol buffers
    • Implement the generation of client and server code from the OpenAPI specifications
    • Automate the code generation in both the Angular app and the microservices
    • Update the Angular app and the microservices to use the generated OpenAPI code
• WebAssembly
  • The Angular application implements a handful of algorithms that can be computationally heavy when the micro-synteny tracks they're computing on are long or there are many of them
    • Speed up these computations by reimplementing them in WebAssembly
• Graph visualizations
  • There's an issue in the GCV repo (Make a micro-synteny graph visualization #395) that talks about implementing a micro-synteny track viewer that displays the micro-synteny tracks as a graph. This could be an interesting project.
    • Implement a graph viewer for micro-synteny tracks
    • Implement a graph viewer for macro-synteny tracks