search

sef-global / scholarx-frontend

This is the frontend of the ScholarX
MIT License
5 stars 57 forks source link

Documentation Bug: Incorrect Start Command in README.md #62

Closed mayura-andrew closed 10 months ago

mayura-andrew commented 10 months ago

Describe the bug The README.md instructs users to run the Node.js frontend application locally using npm start after executing npm install. However, this leads to errors as the package.json file specifies "dev" under the script section instead of "start".

Screenshots Screenshot_20240103_212050

Steps to Reproduce:

  1. Clone the repository.
  2. Navigate to the frontend directory.
  3. Execute npm install.
  4. Attempt to start the application using npm run dev.

Expected Behavior: The application should start successfully without errors, as indicated in the README.md.

Actual Behavior: Running npm start results in errors due to the "dev" script being specified in the package.json file.

Proposed Solution: Update the README.md instructions to reflect the correct command for starting the application, which is npm run dev instead of npm start.

Are you working on it? Yes

anjula-sack commented 10 months ago

Go ahead @mayura-andrew