nodezoo / nodezoo-web

nodezoo.com front end
MIT License
12 stars 61 forks source link

As a user of nodezoo-web, I'd like to be able to: #41

Open Georgette opened 8 years ago

Georgette commented 8 years ago

The more feedback we have, the better an interface becomes. Nodezoo-Web is a way for newcomers to microservices to see them in action, however, we are also exploring our own neat little search engine for modules that is not intended to compete with anything.

Background: The general purpose of this interface is to pull information from various sources related to any particular module. So for instance, if I search for seneca, a microservice framework for node.js, it will pull back information from github, travis, and npm (We will be adding more). So I ask, what information would you find useful, and/or features. The most basic use case is to have everything in one place about a module, but what is "everything."?

So I'm asking, what would you like to see on this interface that would increase the efficiency of our day to day software workflow?

mcdonnelldean commented 8 years ago

For me links are king, can I, from a single page,

I'd also like to see the readme and license too. At the very least I think having the license as some sort of icon or highly visible element would be great as a module searcher.

Simple stats would be epic too.

Georgette commented 8 years ago

I would like to pull in information from coveralls.io

Georgette commented 8 years ago

I was also wondering if it is even feasible to have term search option, even on github readme to start. Often, I am searching a particular part of the api, and the readme is bloated (although, I can do CMD+F search just find I suppose). It would be nice to do term searches in various spots (issues, readme, build fails, etc). This would be fairly difficult, I'd imagine.

Georgette commented 8 years ago

Dependency graphs -- big thing right now is knowing what depends on what. I'm wondering the level of effort required to get a count of dependencies that can be drilled down into. IE: Dependencies: 157, and when clicked on, will actually display a tree.

vislamov commented 8 years ago

As a user I would like to see or have:

Express readme for example has this nice little bar, not sure how it works yet, but looks cool! image

mcdonnelldean commented 8 years ago

@vislamov This is gold! @matt-oc Can you copy this list into an issue and put beside them the service each item needs to originate from and if we already have it or not.

mcdonnelldean commented 8 years ago

@Georgette Search is possible like this with Elastic, I was just checking. It's a little hard to set up but I think we can add this once we stabilize the system. +1 on dependency graph if the data is available from npm / github, this would be great.

mcdonnelldean commented 8 years ago

@Georgette Coveralls is being looked after ;)

Georgette commented 8 years ago

This might not be within the scope of this project on any level however, this project had me thinking about it.

Dependencies are a huge deal right now

but perf tools are as well. We have interfaces like coveralls for showing coverage, but nothing along the lines to display perf tool results for modules. Mind you, setting a project up to run perf tests is a pain, but something that some developers may find enjoyable when they get to compare their solutions against others.

Anyway, an ideal scenario for node zoo would to be able to interface with something that already generates a perf report, and provide information accordingly.

but yeah, someone needs to build the "coveralls" for perfing.

mcdonnelldean commented 8 years ago

I like this idea. @mcollina Would you as a module owner be willing to upload perf results against versions of your modules? I mean we could wrap benchmarking tools in a thing that sent us the data.

Yeah tangent. But I really agree on this!

Georgette commented 8 years ago

If we ever bring in user auth, and sessions, being able to have a dashboard of packages I want to watch would be nice. Probably outside the scope of this project's intent.

mcollina commented 8 years ago

@mcdonnelldean as a module owner I would probably have not time to upload perf results if it is not highly automated. If I could do it launching a single command, then it would be awesome. There are different possible tools for benchmarks: http://npm.im/benchmark https://www.npmjs.com/package/fastbench https://www.npmjs.com/package/autocannon. In general these should likely be free form, because the comparison is highly dependent on the module (while most apps needs REST enpoints, which are easier to standardize, see autocannon).

mcdonnelldean commented 8 years ago

We could certainly explore an endpoint.