wyntonfranklin / electron-tutorial

A markdown file creator using the electron api.

Electron Tutorial

This is a sample application created using the electron api for node. The application I created is a markdown file editor. This sample apps was started using the electron quick start repo.

You can learn more about the electron Api here - https://electronjs.org/

The walk-through for this application can be found here - https://wftutorials.wordpress.com/

Preview

Installation

To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
git clone https://github.com/wyntonfranklin/electron-tutorial.git
# Go into the repository
cd electron-tutorial
# Install dependencies
npm install
# Run the app
npm start

Note: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.

Features

• Create new markdown file
• Open and edit markdown files
• Show recently open files
• Hide recently open files bar
• Rename markdown files

Topics Covered

• Menus
• Dialogs
• Sending Commands
• ipcRender
• Database
• Dependenices
• package.json configuration
• jQuery
• file structure
• File creation use fs module

Resources for Learning Electron

• electronjs.org/docs - all of Electron's documentation
• electronjs.org/community#boilerplates - sample starter apps created by the community
• electron/electron-quick-start - a very basic starter Electron app
• electron/simple-samples - small applications with ideas for taking them further
• electron/electron-api-demos - an Electron app that teaches you how to use Electron
• hokein/electron-sample-apps - small demo apps for the various Electron APIs

License

CC0 1.0 (Public Domain)