Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jcblw/generator-atom-shell-app
:1234: generate apps for atom-shell
https://github.com/jcblw/generator-atom-shell-app
Last synced: 24 days ago
JSON representation
:1234: generate apps for atom-shell
- Host: GitHub
- URL: https://github.com/jcblw/generator-atom-shell-app
- Owner: jcblw
- Created: 2014-05-13T05:39:24.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-05-12T14:03:22.000Z (over 7 years ago)
- Last Synced: 2024-10-11T14:38:42.154Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 12.7 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# generator-atom-shell-app [](https://travis-ci.org/jacoblwe20/generator-atom-shell-app)
This is a baseline app for [atom-shell](https://github.com/atom/atom-shell) that pretty much is the instructions that are given on in [Atom-Shell's Getting Started](https://github.com/atom/atom-shell/blob/master/docs/tutorial/quick-start.md)
## Getting Started
You will need to have [Yeoman](http://yeoman.io) installed.
```bash
$ npm install -g yo
```
To install generator-atom-shell-app from npm, run:
```bash
$ npm install -g generator-atom-shell-app
```
Create a new empty directory for you project, and `cd` into it:
```bash
$ mkdir app-name && cd $_
```
Finally, initiate the generator from within your application directory:
```bash
$ yo atom-shell-app
```
## Running
To run the app, just run `$ npm start`. A window will open with your application embedded within atom-shell.
## Development
To build on the the app all the files reside in the `application` directory.
<% _appName %>
└── app
├── package.json
├── main.js*
└── index.html
With atom-shell the entry point is a javascript file specified in the `package.json` and in this application it is `main.js`
ready for more [atom-shell docs](https://github.com/atom/atom-shell/tree/master/docs)
## Packaging
To package your application as a distributable binary, just run:
$ grunt package
The distributable file will be created in the `/bin` directory at the root of your project.
See the [atom-shell application distribution](https://github.com/atom/atom-shell/blob/master/docs/tutorial/application-distribution.md) wiki for more info.
## License
MIT