Skip to content

Commit 933bf67

Browse files
authored
docs: add troubleshooting and FAQ
Add concise troubleshooting guidance and FAQ to the README.
1 parent 35e3db3 commit 933bf67

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -414,3 +414,29 @@ SecuScan is licensed under the [MIT License](LICENSE). Third-party tools and sca
414414
Thanks to everyone contributing code, plugins, tests, docs, design, issue triage, and reviews.
415415
416416
[View contributors](https://github.com/utksh1/SecuScan/graphs/contributors)
417+
418+
## Troubleshooting
419+
420+
### Installation fails
421+
- Ensure you are using the supported Node.js version.
422+
- Run `npm install` or `npm ci`.
423+
- Delete `node_modules` and reinstall dependencies if necessary.
424+
425+
### Environment variables not loading
426+
- Verify that a `.env` file exists.
427+
- Ensure all required variables are defined.
428+
- Restart the development server after making changes.
429+
430+
## FAQ
431+
432+
### How do I start the project?
433+
Run:
434+
435+
```bash
436+
npm install
437+
npm run dev
438+
```
439+
440+
### How do I report a bug?
441+
Please open a GitHub issue with reproduction steps and relevant logs.
442+

0 commit comments

Comments
 (0)