Create EDX App

A powerful CLI tool to kickstart your Electron Developer eXperience (EDX) projects with a modern, secure, and extensible development setup.

Quick Start

The easiest way to create a new ElectronDX project:

npx create-edx-app my-app
cd my-app
yarn install
yarn start

Usage

Create with project name

npx create-edx-app my-awesome-app

Interactive mode

npx create-edx-app

The CLI will prompt you for the project name and validate the input.

Global Installation

If you prefer to install globally:

npm install -g create-edx-app
create-edx-app my-app

What's Included

Your created project will include:

Template Features

• Modern Electron Setup: Latest Electron with security best practices
• Forge Integration: Electron Forge for building and packaging
• Development Tools: Hot reload, debugging support
• Security: Context isolation, preload scripts
• Project Structure: Organized file structure with clear separation of concerns

Development Features

• Modern JavaScript/ES6+ support
• Built-in security configurations
• Development and production builds
• Cross-platform compatibility
• Extensible architecture

Requirements

• Node.js 14.0.0 or higher
• npm or yarn

Project Structure

Once created, your project will have the following structure:

my-app/
├── src/
│   ├── main.js          # Main process
│   ├── preload.js       # Preload script
│   ├── ApiRegistry.js   # API management
│   ├── Api/             # API modules
│   ├── assets/          # Static assets
│   ├── config/          # Configuration files
│   ├── Models/          # Data models
│   └── utils/           # Utility functions
├── index.html           # Main window HTML
├── debug.html           # Debug window HTML
├── package.json         # Project configuration
├── forge.config.js      # Forge configuration
└── README.md            # Project documentation

Available Scripts

In your created project, you can run:

• yarn start - Start the development server
• yarn make - Build the application for distribution
• yarn publish - Publish to various app stores

Contributing

Issues and pull requests are welcome on GitHub.

License

MIT

📁 Simple Template

• Basic Node.js template structure
• Ready-to-use project setup
• Template folder organization
• Easy to customize and extend

Features

• 🎨 Beautiful CLI interface with colors and ASCII art
• 📝 Interactive prompts for project configuration
• 📦 Ready-to-use React project structure
• 🔧 Pre-configured development tools
• 📖 Comprehensive documentation

Development

Clone the repository:

git clone https://github.com/yourusername/electrondx-cli.git
cd electrondx-cli
yarn install

Link for local development:

yarn link

Publishing

1. Update version in package.json
2. Run tests (if any)
3. Publish to npm:

yarn publish

License

MIT © Your Name

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Support

If you have any questions or issues, please open an issue on GitHub.