https://github.com/soixantecircuits/settings-editor
An editor for settings in JSON format
https://github.com/soixantecircuits/settings-editor
Last synced: 3 months ago
JSON representation
An editor for settings in JSON format
- Host: GitHub
- URL: https://github.com/soixantecircuits/settings-editor
- Owner: soixantecircuits
- Created: 2017-12-22T19:03:15.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-31T09:37:59.000Z (about 7 years ago)
- Last Synced: 2025-01-29T13:44:30.584Z (4 months ago)
- Language: JavaScript
- Size: 754 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# settings-editor
> An editor for settings in JSON format
## ❓Why ?
We use [standard-settings](https://github.com/soixantecircuits/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](https://github.com/soixantecircuits/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](https://github.com/soixantecircuits/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
``` bash
# 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](https://github.com/soixantecircuits/electron-vue)@[1c165f7](https://github.com/soixantecircuits/electron-vue/tree/1c165f7c5e56edaf48be0fbb70838a1af26bb015) using [vue-cli](https://github.com/vuejs/vue-cli). Documentation about the original structure can be found [here](https://soixantecircuits.gitbooks.io/electron-vue/content/index.html).