/Scriptface

A little gui over your project's scripts

Primary LanguageJavaScript

Scriptface

A desktop application providing a little dashboard for your project's scripts.

Drop a folder on the application windows, and it will expose you a simple interface over actionnable scripts

scriptface screenshot

This tool can be used as :

  • a sort of command-line helper for people not used to command line.
  • a first layer of tooling & documentation for your team's projects
  • a lazy tool for lazy people ;)

Features :

  • Allow project-based task definition (persisted in command.json file, in your project root).
  • parses and expose package.json tasks
  • parses and expose grunt tasks
  • parses and expose gulp tasks (done, in the devel branch)
  • parses and expose Makefile contents (TODO)
  • ... etc. TODO

Tools used :

  • node-webkit yeoman generator
  • node-webkit
  • AngularJS (will change)

Install it :

This application uses node-webkit as a runtime.

3 possibilities :

  • Grab a packaged, platform specific version, with node-webkit embedded (see pre-built binaries below).
  • Download and install node-webkit, download the app archive (*.nw file), launch node-webkit with the app archive as parameter (not yet).
  • Download and install node-webkit, setup a build environnement (see below, "Build and run your own version").

prebuilt binaries :

You're a foolish alpha-tester, okay :

https://www.dropbox.com/sh/vehbwf22hy6upqs/AAAvZJzOsyDwbMfbU46StMwMa

Be warned, it's still rude (but it seems to do the job).

How to customise, play with it

Build and run your own version :

Build environnement :

  • install the yeoman generator generator-node-webkit
  • Run it on a folder

Project :

  • clone this project in your_node-webkit_folder/app/
  • do npm install and bower installin the folder

Launching : Basically node-webkit_executable_path "your_app_folder" :

/Applications/node-webkit.app/Contents/MacOS/node-webkit "/your_folder_path/app/"

How to contribute ?

You found that app useful, you want to add some features ?

The app is a pretty alpha state and important changes are planned (switching to vuejs or reactJs for example). You can be a part of them, let's talk in issues section.

TODOs :

Links and references