https://github.com/virtuoworks/electron-sahara
Electron Sahara is an Apache Cordova like command line utility for electron.
https://github.com/virtuoworks/electron-sahara
cli electron electron-app electronjs javascript node node-js nodejs
Last synced: 8 months ago
JSON representation
Electron Sahara is an Apache Cordova like command line utility for electron.
- Host: GitHub
- URL: https://github.com/virtuoworks/electron-sahara
- Owner: VirtuoWorks
- License: mit
- Created: 2017-05-19T10:58:03.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T18:13:13.000Z (over 3 years ago)
- Last Synced: 2024-04-14T11:50:43.633Z (about 2 years ago)
- Topics: cli, electron, electron-app, electronjs, javascript, node, node-js, nodejs
- Language: JavaScript
- Homepage:
- Size: 577 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![NPM Version][npm-image]][npm-url]
[![NPM Downloads][downloads-image]][downloads-url]
[![Build Status][travis-image]][travis-url]
[![Test Coverage][coveralls-image]][coveralls-url]
[![Codacy Badge][codacy-image]][codacy-url]
[![Dependency Status][dependencyci-image]][dependencyci-url]
# Electron Sahara
- **Desktop apps with HTML, CSS & JS**
- **Target multiple platforms with one code base**
- **Free and open source**
**Electron Sahara** is an *Apache Cordova like* command line utility for **electron**.
Supported platforms :
> 
## Installing Sahara
Sahara command-line runs on Node.js and is available on NPM. Follow platform specific guides to install additional platform dependencies. Open a command prompt or Terminal, and type ``npm install -g electron-sahara``
Example :
```
npm install -g @virtuoworks/electron-sahara
```
## Create a project
Create a blank Sahara project using the command-line tool. Navigate to the directory where you wish to create your project and type ``sahara create ``.
For a complete set of options, type ``sahara help create``.
Example :
```
sahara create MyApp
```
### Templates
Templates allow you to use preexisting code to jumpstart your project. Navigate to the directory where you wish to create your project and type ``sahara create [template]``
Available templates :
- `` vanilla `` (default)
- `` react ``
- `` angular2 ``
- `` vuejs ``
Example :
```
sahara create MyApp angular2
```
## Prepare a platform
After creating a Sahara project, navigate to the project directory. From the project directory, you need to prepare a platform for which you want to build your app.
To prepare a platform, type ``sahara prepare ``.
For a complete list of platforms you can run ``sahara prepare``.
Example :
```
cd MyApp
sahara prepare win32
```
Available platforms :
- `` win32`` (for Windows (32/64 bit))
- `` darwin `` (for OS X (also known as macOS))
- `` linux `` (for Linux (x86/x86_64))
## Compile a platform
After having prepared a platform, navigate to the project directory. From the project directory, you can compile a release for a platform.
To compile a platform, type ``sahara compile ``.
For a complete list of platforms you can run ``sahara compile``.
Example :
```
cd MyApp
sahara compile win32
```
## Prepare AND Compile a platform
If you which to perform both operations in a row, navigate to the project directory. From the project directory, type ``sahara build ``.
Example :
```
cd MyApp
sahara build win32
```
## Run your app
From the command line, run ``sahara run ``.
`` sahara run win32 ``
## Requirements
- [Node.js](https://nodejs.org/en/download/) (>=4.7)
- [Git](https://git-scm.com/downloads)
## License
[MIT](LICENSE)
[npm-image]: https://img.shields.io/npm/v/@virtuoworks/electron-sahara.svg
[npm-url]: https://www.npmjs.com/package/@virtuoworks/electron-sahara
[downloads-image]: https://img.shields.io/npm/dm/@virtuoworks/electron-sahara.svg
[downloads-url]: https://www.npmjs.com/package/@virtuoworks/electron-sahara
[travis-image]: https://api.travis-ci.org/VirtuoWorks/electron-sahara.svg?branch=master
[travis-url]: https://travis-ci.org/VirtuoWorks/electron-sahara
[coveralls-image]: https://coveralls.io/repos/github/VirtuoWorks/electron-sahara/badge.svg?branch=master&seed=3426236
[coveralls-url]: https://coveralls.io/github/VirtuoWorks/electron-sahara?branch=master
[codacy-image]: https://api.codacy.com/project/badge/Grade/a72b34b2d9194fe68a827c0a38f97aa9
[codacy-url]: https://www.codacy.com/app/VirtuoWorks/electron-sahara?utm_source=github.com&utm_medium=referral&utm_content=VirtuoWorks/electron-sahara&utm_campaign=Badge_Grade
[dependencyci-image]: https://dependencyci.com/github/VirtuoWorks/electron-sahara/badge
[dependencyci-url]: https://dependencyci.com/github/VirtuoWorks/electron-sahara