search

ECAM-2023 / jira-connector

MIT License
0 stars 1 forks source link

Missing a documentation with the minimum requirement to setup the backend, frontend and jira connector #3

Open yboujraf opened 1 year ago

yboujraf commented 1 year ago

Dear @MouradMettioui , @VictorVanO , @MaillardCorentin

I am expecting the documentation in restructuredText .rst (sphinx-doc) for :

  1. Jira connector
  2. backend
  3. database
  4. frontend

Best Regards

yboujraf commented 1 year ago

Dear @MouradMettioui , @VictorVanO , @MaillardCorentin

I didn't find any README.rst in your project. I am expecting, when you clone the repository. What I need to do to install all nodejs and npm software, to install the npm packages, which vscode extension I need to enable, where to download and install the database and how to setup, which script I need to apply to compile the code and start it ?, which is the .env variable for jira-connector, backend and frontend (url, port, email address, apitoken, cloudid, clientid, secretid,...) how to configure jira to enable webhook, generate clientid, secretid, apitoken, ... probably available on CANVA but I need on sphinx-doc.

Best regards

VictorVanO commented 1 year ago

Dear @yboujraf, there is already a README.md file in the base of the project. I just updated it with more explanation on how to start the frontend and the backend. Please let me know if you have troubles following the instructions.

As for the documentation, we are working on it.

Respectfully,

MaillardCorentin commented 1 year ago

Dear @yboujraf, we don't support the OAuth 2.0 authentification methode. There for, there are no client id, client secret and cloud id. The methode that we use is the API token which only use the email adresse and the api token from jira.

yboujraf commented 1 year ago

Dear @MaillardCorentin

Understood because Atlassain is not providing the email address regarding the GDPR issue.

But you could let all this information for the next developper in case Atlassian will extend the right to access on.

Best regards,

yboujraf commented 1 year ago

Dear @VictorVanO

The existing README.md can't give to any user which IDE to use with extension, which command to run like npm install, npm run script to build, start the connector, backend, frontend, url, port, apitoken,.... (all need to be in an .env files. Here all are hardcoded in your code.

Best Regards,

yboujraf commented 1 year ago

Dear @VictorVanO , @MaillardCorentin , @MouradMettioui

Would you like to share your repo with all the contents as request ?

Best Regards