DOC:Improving the README for "Voice of Justice" (VOJ) Project

Data-Sculptor-X / VOJ-ReactJS

12 stars 29 forks source link

DOC:Improving the README for "Voice of Justice" (VOJ) Project #30

Closed daud0x0 closed 1 month ago

daud0x0 commented 1 month ago

What's wrong with the existing documentation

Missing Installation and Setup Instructions: The README does not explain how a user can run the project locally or test it. There's no guidance on setting up the development environment or dependencies.

Add ScreenShots

Screenshot from 2024-10-15 22-44-46

Record

[X] I agree to follow this project's Code of Conduct
[X] I have checked the existing issues
[X] I'm a GSSOC'24-Extended contributor
[X] I want to work on this issue

github-actions[bot] commented 1 month ago

👋 Thank you for raising an issue! We appreciate your effort in helping us improve. Our VOJ team will review it shortly. Stay tuned!

Prithwi32 commented 1 month ago

@daud0x0 did u done setup in your pc?

daud0x0 commented 1 month ago

I tried but failed to run (node 20)

Prithwi32 commented 1 month ago

I tried but failed to run (node 20)

npm i, did u run?

daud0x0 commented 1 month ago

yess

Prithwi32 commented 1 month ago

yess

@daud0x0 feel free to get on discussion in discussion section

Prithwi32 commented 1 month ago

@daud0x0 npm install ajv@latest ajv-keywords@latest use this command to update to new version, then npm start to run react app