aboutcode-org / purldb

Tools to create and expose a database of purls (Package URLs). This project is sponsored by NLnet project https://nlnet.nl/project/vulnerabilitydatabase/ and nexB for https://www.aboutcode.org/ Chat is at https://gitter.im/aboutcode-org/discuss
https://purldb.readthedocs.io/
35 stars 23 forks source link

Create UI for purldb in the style of SCIO and VCIO #20

Open pombredanne opened 1 year ago

pombredanne commented 1 year ago

This should allow searching for a purl for a start, beyond the API-only approach we have so far.

sikehish commented 1 year ago

What us SCIO and VCIO?

swastkk commented 1 year ago

What us SCIO and VCIO?

SCIO is Scancode.io and VCIO is VulnerableCode

0saurabh0 commented 1 year ago

@pombredanne I'm interested in working on this feature. Any steps for getting started?

devdev29 commented 1 year ago

the issue asks to make a UI for purldb, I assume this means that I have to create a UI for interacting with the API that resides in the packagedb folder? I'm also curious about the tools I can use for building the UI, do I have to use django or can I use other frameworks like react?

DennisClark commented 1 year ago

I believe that we should use django for the purdb.io especially since we have working examples in vulnerablecode.io and scancode.io

Working tiltle: purlDB.io

Some design ideas: A basic columnar presentation should include these fields:

purl | Type | Name | Version | License | Download URL

"purl" should provide a link to a details form

LIcense is actually a license expression field, and each key value in the expression should provide a link to the ScanCode LicenseDB.

Clicking on a Download URL should activate an actual package download.

There should be a Filter dropdown to provide filtering by these values: Date added Date modified Type Namespace Name Version Download URL Filename SHA1 MD5 Size Release date Package URL

There should be multiple Sorting options (more work needed on this idea).

The Details form should include all of these fields (and others to be identified): Package URL Filename Download URL Size Release date Primary language Description License expression Type Namespace Name Version Homepage URL SHA1 Declared license Dependencies Source packages Parties

More design ideas to follow ...

DennisClark commented 1 year ago

On the basic columnar presentation form, there should be a generalized Search field that should be optimized for a purl or part of a purl.

Shubhisingh921 commented 1 year ago

Hi Mentors

I am Shubhi Singh a technology enthusiast and first time participating in GSOC with the wish to be contributing towards 'PURLdb'

As per Contribution Guide I would like to introduce myself as a candidate to work on this project which is selected for GSOC 2023

Q1) What interests you most about this project ?

I researched about "SCIO and VCIO" and thought about the overall idea towards achieving the goal of easing out ways to search Project Related

I wish to contribute towards the project as this means working with multiple features which is fascinating as a tech enthusiast and putting out my first step towards Open source.

At present I have knowledge of Mern Stack,C++,Web3,yaml, REST API, API, Machine Learning, Python, Java, JavaScript, Asynchronous programming, Search Engine, etc which can help towards contributing towards this project

I believe in continuous improvement hence open to feedback [ be it technical or social or in other areas ], willing to learn new technologies, tools and approaches to improve my skills and contribute towards the project.

At present I am planning to implement mini project with Project Related specifications so I can contribute towards the project with deeper understanding.

Q3) Is there anything that you’ll be studying or working on whilst working alongside us?

I am a working professional in the field of frontend Developer , with a Computer Science background.

While working on this project, I plan on researching on various authentication and authorization methods to ensure that my contributions are meaningful and up-to-date. I will also be working on improving my coding skills to ensure that my code is efficient, maintainable, and meets the project standards.

Q4) We'd love to hear a bit on your work preferences, e.g. how you keep yourself organized, what tools you use, etc?

I like planned things; in situations where a project is not planned out with no proper communication, I tend to get a bit anxious as in my mind the priority is to complete the task.

I can give daily 4-5hr or more (depending upon office work) towards this project.

I am open to work in US, UK, or India timezone depending upon the project requirement.

To keep myself organized I make use of notepads, reminders, Git, Github, Google Calander and personal notes.

I believe in continuous improvement hence open to feedback [ be it technical or social or in other areas ], willing to learn new technologies, tools and approaches to improve my skills and contribute towards the project.

I request you to provide me with Mandatory qualification task so I can start contributing towards the project.

Looking forward to hearing from your side