docs: added running-the-web-app.md

qhtutorials commented 3 weeks ago

User description

Description

Added running-the-web-app.md to the running-things-locally folder in the docs

Fixes #[185]

Documentation Update

[X ] I have made the necessary updates to the documentation, or no documentation changes are required.

PR Type

Documentation

Description

Added a new markdown file running-the-web-app.md with detailed instructions on how to run the web app locally.
Included commands for:
- Running the Next.js development environment.
- Running tests using Jest.
Provided a URL for viewing the web app.

Changes walkthrough 📝

Relevant files

Documentation

running-the-web-package.md

Added documentation for running the web package locally.

docs/contributing-to-keyshade/running-things-locally/running-the-web-package.md

Added a new markdown file with instructions on running the web
package.

Included commands for development, building, production, linting, and
testing.

Provided a URL for viewing the web app.

+52/-0

💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

codiumai-pr-agent[bot] commented 3 weeks ago

PR Reviewer Guide 🔍

⏱️ Estimated effort to review [1-5]	1
🧪 Relevant tests	No
🔒 Security concerns	No
⚡ Key issues to review	None

rajdip-b commented 3 weeks ago

@kriptonian1 hey bro can you drop a quick review?

codiumai-pr-agent[bot] commented 3 weeks ago

PR Code Suggestions ✨

Category	Suggestion	Score
Enhancement	Provide explanations for each command to help new contributors understand their purpose ___ Adding a brief explanation of what each command does (e.g., what 'npm run dev' specifically starts or configures) can provide better context for new contributors who might not be familiar with the tools or the project structure. [docs/contributing-to-keyshade/running-things-locally/running-the-web-package.md [12]](https://github.com/keyshade-xyz/keyshade/pull/269/files#diff-ad64bb6b90c88808b3cf78ffea8e49dff964750c9057db246e55b78a2f657677R12-R12) ```diff ``` -npm run dev +npm run dev # Starts the development server for the web app, allowing live reloading for faster development. ``` ``` Suggestion importance[1-10]: 9 Why: Adding explanations for each command is highly beneficial for new contributors who may not be familiar with the project or the tools being used. This enhances the documentation's clarity and educational value.	9
Best practice	Include troubleshooting steps to assist users in resolving issues with running commands ___ It's beneficial to include error handling advice or common troubleshooting steps after the command instructions. This can assist users in resolving issues they might encounter while running these commands. [docs/contributing-to-keyshade/running-things-locally/running-the-web-package.md [24]](https://github.com/keyshade-xyz/keyshade/pull/269/files#diff-ad64bb6b90c88808b3cf78ffea8e49dff964750c9057db246e55b78a2f657677R24-R24) ```diff ``` npm run start +# If you encounter any issues, check the Node.js console for errors or consult the troubleshooting guide. ``` ``` Suggestion importance[1-10]: 8 Why: Adding troubleshooting steps is a valuable addition that can help users resolve common issues, improving the overall usability of the documentation. This suggestion is contextually accurate and enhances the user experience.	8
Maintainability	Organize commands into sections with subheadings for better clarity and maintainability ___ To enhance clarity and maintainability, consider separating the commands into different sections with subheadings for development, building, and testing. This can make the document more organized and easier to follow. [docs/contributing-to-keyshade/running-things-locally/running-the-web-package.md [12-24]](https://github.com/keyshade-xyz/keyshade/pull/269/files#diff-ad64bb6b90c88808b3cf78ffea8e49dff964750c9057db246e55b78a2f657677R12-R24) ```diff +## Development ``` npm run dev ``` +## Build ``` npm run build ``` +## Production ``` npm run start ``` ``` Suggestion importance[1-10]: 7 Why: Separating commands into sections with subheadings improves the readability and organization of the document. This makes it easier for users to follow the instructions, especially for those who are new to the project.	7

rajdip-b commented 2 weeks ago

Hey @qhtutorials, the steps still feel odd.

The commands are incorrect
Building the code shouldn't be included since this page is just concerned with how you can run the web project locally
I would suggest you to try running the code on your device, you will have a better idea

kriptonian1 commented 2 weeks ago

@kriptonian1 hey bro can you drop a quick review?

sure

kriptonian1 commented 2 weeks ago

@qhtutorials One suggestion, before writing a doc it is recommended to go through the project, and for monorepo check both root and the application package.json if it's a node based project.