From 326190301d9ae31c7442b7f454fcbe16b2d8a8ca Mon Sep 17 00:00:00 2001 From: DIPIKA VAMAN KANTAPPA POOJARI Date: Sun, 9 Aug 2026 11:15:29 +0400 Subject: [PATCH] Enhance README with troubleshooting and FAQ Added troubleshooting and FAQ sections to README. --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 232df9c92..15248672a 100644 --- a/README.md +++ b/README.md @@ -414,3 +414,29 @@ SecuScan is licensed under the [MIT License](LICENSE). Third-party tools and sca Thanks to everyone contributing code, plugins, tests, docs, design, issue triage, and reviews. [View contributors](https://github.com/utksh1/SecuScan/graphs/contributors) + +## Troubleshooting + +### Installation fails +- Ensure you are using the supported Node.js version. +- Run `npm install` or `npm ci`. +- Delete `node_modules` and reinstall dependencies if necessary. + +### Environment variables not loading +- Verify that a `.env` file exists. +- Ensure all required variables are defined. +- Restart the development server after making changes. + +## FAQ + +### How do I start the project? +Run: + +```bash +npm install +npm run dev +``` + +### How do I report a bug? +Please open a GitHub issue with reproduction steps and relevant logs. +