[FEATURE] Set readme as Project Details

jobenjada commented 3 months ago

Is your feature request related to a problem? Please describe.

Currently, the project details card is empty:

Describe the solution you'd like

This isn't an easy task, so please only assign yourself if you bring enough experience to complete it 🤓

Our goal is the following in a nutshell:

Pull readme from repo on creation
Set readme content as projectDetails
Display it parsing the MDX correctly

More context:

Pull readme from repo on creation

When a maintainer connects oss.gg with their repo, we create a repository and an installation in the oss.gg database. Have a look at this file as a starting point:

https://github.com/formbricks/oss.gg/blob/main/lib/github/hooks/installation.ts

We likely need a new service which pulls the readme from a repo via the GitHub API, but it's your task to find that out and propose a solution 🤓

Set readme content as projectDetails

We already have projectDescription String? field in the Prisma schema. Store it there.

Display it parsing the MDX correctly

Pick a widely used and performant package to then parse the string into rich text. Display it here:

Describe alternatives you've considered

No response

Additional context

No response

nik132-eng commented 3 months ago

/assign

manish-singh-bisht commented 3 months ago

/assign

oss-gg[bot] commented 3 months ago

You already have an open issue assigned to you here. Once that's closed or unassigned, only then we recommend you to take up more.

oss-gg[bot] commented 3 months ago

You already have an open issue assigned to you here. Once that's closed or unassigned, only then we recommend you to take up more.

oss-gg[bot] commented 3 months ago

You already have an open issue assigned to you here. Once that's closed or unassigned, only then we recommend you to take up more.

oss-gg[bot] commented 3 months ago

You already have an open issue assigned to you here. Once that's closed or unassigned, only then we recommend you to take up more.

oss-gg[bot] commented 3 months ago

You already have an open issue assigned to you here. Once that's closed or unassigned, only then we recommend you to take up more.

oss-gg[bot] commented 3 months ago

You already have an open issue assigned to you here. Once that's closed or unassigned, only then we recommend you to take up more.

oss-gg[bot] commented 3 months ago

You already have an open issue assigned to you here. Once that's closed or unassigned, only then we recommend you to take up more.

oss-gg[bot] commented 3 months ago

You already have an open issue assigned to you here. Once that's closed or unassigned, only then we recommend you to take up more.

oss-gg[bot] commented 3 months ago

You already have an open issue assigned to you here. Once that's closed or unassigned, only then we recommend you to take up more.

manish-singh-bisht commented 3 months ago

/assign

oss-gg[bot] commented 3 months ago

You already have an open issue assigned to you here. Once that's closed or unassigned, only then we recommend you to take up more.

oss-gg[bot] commented 3 months ago

You already have an open issue assigned to you here. Once that's closed or unassigned, only then we recommend you to take up more.

oss-gg[bot] commented 3 months ago

You already have an open issue assigned to you here. Once that's closed or unassigned, only then we recommend you to take up more.

oss-gg[bot] commented 3 months ago

You already have an open issue assigned to you here. Once that's closed or unassigned, only then we recommend you to take up more.

oss-gg[bot] commented 3 months ago

You already have an open issue assigned to you here. Once that's closed or unassigned, only then we recommend you to take up more.

manish-singh-bisht commented 3 months ago

Will give it a shot.

/assign

manish-singh-bisht commented 3 months ago

/assign

mdhruvil commented 3 months ago

/assign

raysubham commented 3 months ago

/assign

oss-gg[bot] commented 3 months ago

You already have an open issue assigned to you here. Once that's closed or unassigned, only then we recommend you to take up more.

oss-gg[bot] commented 3 months ago

You already have an open issue assigned to you here. Once that's closed or unassigned, only then we recommend you to take up more.

oss-gg[bot] commented 3 months ago

You already have an open issue assigned to you here. Once that's closed or unassigned, only then we recommend you to take up more.

oss-gg[bot] commented 3 months ago

You already have an open issue assigned to you here. Once that's closed or unassigned, only then we recommend you to take up more.

raysubham commented 3 months ago

/assign

formbricks / oss.gg