Electron-React Template with MIT License

This repository is a ready-to-use template for Electron + React projects, licensed under the MIT License. It provides a solid starting point, including essential configurations and examples, to accelerate the development of desktop applications using Electron and React.

Features

• MIT License: Open-source license for unrestricted usage and modification.
• Structured Project Layout: Organized for ease of navigation and scalability.
• Automated Commit Tasks: Utilizing VS Code and Bash scripts for streamlined workflows.
• Pre-configured Essential Plugins: Quick setup with necessary development tools.
• Standardized Project Files: Includes .env, .gitconfig, .editorConfig, and more for a consistent development environment.
• Customizable UI Components: Tailor the user interface to fit your project's needs.
• Integrated SVG Icons: Enhance visual feedback with scalable graphics.
• Enhanced Email Validation: Ensure accurate user input with advanced validation techniques.

Getting Started

1. Clone the repository:

   git clone https://github.com/YourUsername/electron-react-template.git
   cd electron-react-template

2. Install dependencies:

   npm install

3. Start the Development Server:

   npm start

Generate a GitHub Personal Access Token

To publish your Electron app to GitHub, you need to generate a personal access token. Follow these steps:

1. Access GitHub Settings:

   • Go to your GitHub profile.
   • Click on your profile picture in the top right corner and select "Settings".

2. Navigate to Developer Settings:

   • In the settings menu, find and click on "Developer settings".

3. Personal Access Tokens:

   • Select "Personal access tokens" from the sidebar.
   • Click on "Generate new token".

4. Token Settings:

   • Give your token a descriptive name.
   • Set the necessary scopes (e.g., "repo" for full repository access).
   • Click "Generate token" at the bottom.

5. Copy and Secure Your Token:

   • Important: Copy your new personal access token now. You won’t be able to see it again!
   • Securely store the token for future use.

6. Set Up Environment Variable:

   • Add the token to your environment variables as GITHUB_TOKEN.

Explore the Template

Navigate through the src directory to understand the structure. Customize components and configurations to align with your project requirements.

Automation Tools

Leverage the included VS Code tasks and bash scripts for automating repetitive tasks. Refer to tasks.json and the corresponding scripts for more information.

Configuration Files

The template comes with pre-configured files like .env, .gitconfig, and .editorConfig, setting a standard for development practices.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are highly appreciated. To contribute, please fork the repository and create a pull request with your proposed changes.

---

This template is designed to reduce setup time and complexity, allowing you to focus on building innovative Electron-React applications.

Author: Ricardo Malnati