Skip to content

Latest commit

 

History

History
89 lines (54 loc) · 4.3 KB

README.md

File metadata and controls

89 lines (54 loc) · 4.3 KB

generator-atom-shell Build Status

Yeoman generator

Screenshot

About Atom-Shell Generator

This generator is for creating desktop applications using Github's Atom-Shell.

Binary Atom-Shell

This generator downloads a binary release build of Atom-Shell. If you need a newer or older version you can find a list of release binaries here. Edit the gulpfile.js and the task for 'atom-download'. Specify your binary version you want in the version property.

Atom-Shell can be customized and has a lot of things you can do with it. You can edit the src/main.js file to tweak your shell. Here's a link to the Atom-Shell API Docs.

Getting Started

Install Yeoman

npm install -g yo

Yeoman Generators

To install generator-atom-shell from npm, run:

npm install -g generator-atom-shell

Finally, initiate the generator:

yo atom-shell

App

The default post-install hook for this generator is to build and launch Atom-Shell. You can terminate the Atom-Shell by using ctrl+c in the terminal. You can run any of the Gulp commands or the default which will build and launch Atom-Shell.

gulp #run default tasks
gulp launch #runs only the Atom-Editor launch command

Supported Frameworks, Libraries, and Testing

This generator supports several Application Frameworks, Front-End Framework/libraries and Testing Framework/Tools. If you'd like to see the current versions supported for each or want to modify them, check out the versions.json file located in the app/templates folder.

If you'd like to add your favorite framework, library or tool, clone this repo, add your framework and version to the versions.json file. Make sure it works by using the generator. If it all looks good, send me a PR.

Application Frameworks

Currently there is support for the following Application Frameworks:

If you're interested in adding your framework, DO IT!

Front-End Frameworks

Currently there is support for the following Front-End Frameworks:

If you're interested in adding your Front-End framework, DO IT!

Testing Frameworks and Tools

Currently there is support for the following Front-End Frameworks:

If you're interested in adding your Testing framework, DO IT!

License

MIT