Skip to content

Latest commit

 

History

History
87 lines (51 loc) · 2.18 KB

README.md

File metadata and controls

87 lines (51 loc) · 2.18 KB

settings-editor

An editor for settings in JSON format

❓Why ?

We use standard-settings a lot. Actually we use it in every nodeJS and electron project.

Sometimes, we need a regular human to change the settings in production.
This an alternative to ssh + vim

🌍 Installation

yarn

⚙ Configuration

cp settings/settings.default.json settings/settings.json

And edit settings.json,
change the filepath value to a path of a settings file that you want to be available for web editing.

You can also change settings with argv parameters. Learn more about this on standard-settings

👋 Usage

yarn run dev

settings-bro

By default, settings-editor will send settings on spacebro. If you want to work locally, meaning that you will run this application as an app on the same computer as the file you want to edit, skip to next section.

To use this app to edit file on another computer, run settings-bro on the computer where you want to edit a settings file. Edit settings-bro settings file and change attribute folder.settings to the folder that contains the file to be edited.

save file locally

Edit settings.settings.json and change useSpacebro to false. The app will read and write directly on local disk.

Full Build Setup

# install dependencies
npm install

# serve with hot reload at localhost:9080
npm run dev

# build electron application for production
npm run build

# run unit & end-to-end tests
npm test


# lint all JS/Vue component files in `src/`
npm run lint

🕳 Troubleshooting

Ask emmanuel on soixantecircuits.slack.com

❤️ Contribute

Please do!


This project was generated with electron-vue@1c165f7 using vue-cli. Documentation about the original structure can be found here.