electron-root-path

npm: electron-root-path

• Author: Ganesh Rathinavel
• License: MIT
• Website URL: https://github.com/ganeshrvel/npm-electron-root-path
• Repo URL: https://github.com/ganeshrvel/npm-electron-root-path
• Contacts: [e-mail]

Introduction

Get the root path of an Electron Application.

Finding the root path of an electron app can be tricky. I have written a npm package to deal with this.

Initially, I'd created electron-root-path package for OpenMTP - Advanced Android File Transfer Application for macOS. It works fine with Electron-React-Redux Advanced Boilerplate and electron-react-boilerplate

Installation

$ npm install electron-root-path

or 

$ yarn add electron-root-path

Usage

// Import ES6 way
import { rootPath } from 'electron-root-path';

// Import ES2015 way
const rootPath = require('electron-root-path').rootPath;

// e.g:
// read a file in the root
const location = path.join(rootPath, 'package.json');
const pkgInfo = fs.readFileSync(location, { encoding: 'utf8' });

• The 'location' variable will point to <APP_PACKAGE_NAME>.app directory after packaging the app.

Building from Source

Requirements: Node.js v6+, Git and npm

Clone

$ git clone --depth 1 --single-branch --branch master https://github.com/ganeshrvel/npm-electron-root-path.git

$ cd npm-electron-root-path

Contribute

• Fork the repo and create your branch from master.
• Ensure that the changes pass linting.
• Update the documentation if needed.
• Make sure your code lints.
• Issue a pull request!

When you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Buy me a coffee

Help me keep the app FREE and open for all. Paypal me: paypal.me/ganeshrvel

Contacts

Please feel free to contact me at [e-mail]

More repos

• Electron React Redux Advanced Boilerplate
• OpenMTP - Advanced Android File Transfer Application for macOS

License

electron-root-path | Get the root path of an Electron Application is released under MIT License.

Copyright © 2018 - 2019 Ganesh Rathinavel