Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat - added typerscript tutorial for typesrcipt in electron #706 #713

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Shashikumar-ezhilarasu
Copy link

This PR proposes adding a beginner-friendly guide to the documentation, explaining how to set up a TypeScript environment for Electron applications. It includes:

Steps to set up a project with electron-vite and nextron for faster onboarding.
Instructions on building a basic TS setup manually for better understanding.
Highlights TypeScript's advantages for maintainability and scalability.
The goal is to provide a smooth introduction for beginners and empower them to confidently use TypeScript with Electron.

Proposed Solution:
Introduce a concise tutorial outlining:

Tools like electron-vite and nextron for a quick TypeScript setup.
A step-by-step approach for building a TS project from scratch.
This ensures both beginners and advanced users find value.

Relevant Issue no : #706

@Shashikumar-ezhilarasu Shashikumar-ezhilarasu requested a review from a team as a code owner December 18, 2024 18:23
@nikwen
Copy link

nikwen commented Dec 26, 2024

This PR seems AI-generated to me.

I think the Electron Forge docs are a better way to get started with TypeScript. Maybe it would make sense to link from the Electron docs to Forge to help people initialize a TypeScript project.

What would need to change for this PR to pass basic standards:

  1. Proper (Markdown) formatting
  2. Submit the PR to the main Electron repo, not the website repo
  3. Remove unnecessary added files
  4. Maybe: remove references to unofficial npm packages
  5. Probably more …

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants