docs: add comprehensive run instructions and improve README formatting

[webdevcody]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @webdevcody, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the project's documentation by introducing a comprehensive 'How to Run' guide within the README.md file. The update aims to streamline the onboarding process for new contributors and provide clear, consolidated instructions for setting up, developing, building, testing, and linting the application across different environments and modes. It also includes minor formatting improvements to existing sections.

Highlights

• Comprehensive Run Instructions: A new 'How to Run' section has been added to the README, providing detailed instructions for various development, build, and operational modes.
• Development Modes: Instructions for running the application in Electron Desktop App mode (standard, debug, WSL, WSL with GPU) and Web Browser mode have been clearly outlined.
• Build and Production: Guidance for building production Next.js and Electron applications, as well as running the production Next.js server, is now included.
• Testing and Linting: Dedicated subsections for running tests (headless and headed) and executing ESLint for linting have been added to the README.
• README Formatting Improvement: The formatting of the 'Authentication Options' markdown table has been improved for better readability and alignment.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request significantly improves the project's README by adding a comprehensive 'How to Run' section and reformatting the authentication options table for better readability. The new instructions are clear, well-structured, and cover various scenarios like development, production builds, testing, and linting. I've added a couple of suggestions to further clarify the build and run process for production, ensuring users have a smooth experience.

[gemini-code-assist]

The description for npm run build:electron could be clearer. Since the build:electron script (next build && electron-builder) already includes the build step, it's helpful to mention this to avoid users running npm run build redundantly. Also, clarifying that npm run build is for the web app would improve clarity.

Suggested change

	# Build Next.js app
	npm run build
	# Build Electron app for distribution
	npm run build:electron
	# Build the Next.js web app
	npm run build
	# Build the Electron app for distribution (this also runs `npm run build`)
	npm run build:electron

[gemini-code-assist]

The npm run start command requires the application to be built first using npm run build. It would be helpful to explicitly state this prerequisite in the comment to prevent potential confusion for users trying to run the production server.

Suggested change

	# Start production Next.js server
	# After running `npm run build`, start the production Next.js server