doclin-dev / doclin

Server and VS Code Extension of Doclin
https://doclin.dev
GNU Affero General Public License v3.0
44 stars 22 forks source link

Require ability to edit project name etc. #135

Open shawonibnkamal opened 2 months ago

shawonibnkamal commented 2 months ago

Currently, user do not have the ability to edit project name once a project is created. We need to add another component with an edit form that can update project details. This will require the following steps:

Webviews:

  1. Add a new component EditProject.svelte.
  2. Add a new enum member EditProject to enum Page in extension/webviews/enums.ts.
  3. To access the component, we need to add a new button in ViewerTopBar.svelte. On clicking the button, it should change the $page state to Page.EditProject.
  4. Need to update Sidebar.svelte, to handle the change of $page to EditProject. So when the button is clicked, it should show the new component to EditProject.svelete
  5. Complete EditProject.svelte to have a form, on submission should send a message to the extension level.

Extension level:

  1. Add a new entry in RESPONSE_PROVIDERS in webviewMessageFunctions.ts.
  2. You can follow projectProviderHelper.postProject on how we interact with the axios service to send request to the backend.

Backend:

  1. Add a new route for update in projectRouter.
  2. Add a new method in projectController that will be triggered by the router.
  3. Code will be similar to postProject, except should use the update method.
abhedanil commented 2 months ago

Could you please describe the issue , so that i can take up and work on this

shawonibnkamal commented 2 months ago

Hi @abhedanil, thank you for showing interest in this project. I am sorry this issue has plenty of steps and it was not wise of me to mark it as good first issue. There is a better first issue https://github.com/doclin-dev/doclin/issues/132 . Would you like to work on that instead?

abhedanil commented 2 months ago

Yes @shawonibnkamal , please assign it to me .

shawonibnkamal commented 2 months ago

Yes @shawonibnkamal , please assign it to me .

@abhedanil can you comment on the issue? Your name won’t show up on suggestions otherwise.