An open API service indexing awesome lists of open source software.

https://github.com/brentonhouse/geek-mobile

🚀Geek Mobile Toolkit - Everything a geek needs to create, build, and manage cross-platform native mobile apps.
https://github.com/brentonhouse/geek-mobile

alias alloy appcelerator appcelerator-titanium brenton-house cli cross-platform-native geek icons mobile native nodejs npm oclif plugin resources titanium titanium-alloy titanium-mobile toolkit

Last synced: 13 days ago
JSON representation

🚀Geek Mobile Toolkit - Everything a geek needs to create, build, and manage cross-platform native mobile apps.

Awesome Lists containing this project

README

        

# Geek Mobile Toolkit
=========
> Everything a geek needs to create, build, and manage cross-platform native mobile apps.

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/@geek/mobile.svg)](https://npmjs.org/package/@geek/mobile)
[![Downloads/week](https://img.shields.io/npm/dw/@geek/mobile.svg)](https://npmjs.org/package/@geek/mobile)
[![License](https://img.shields.io/npm/l/@geek/mobile.svg)](https://github.com/brentonhouse/geek-mobile/blob/master/package.json)

# Usage

```sh-session
$ npm install -g @geek/mobile
$ mobile COMMAND
running command...
$ mobile (-v|--version|version)
@geek/mobile/1.0.5 darwin-x64 node-v12.16.3
$ mobile --help [COMMAND]
USAGE
$ mobile COMMAND
...
```

# Commands

* [`mobile app:create [NAME] [TEMPLATE]`](#mobile-appcreate-name-template)
* [`mobile help [COMMAND]`](#mobile-help-command)
* [`mobile which COMMAND`](#mobile-which-command)

## `mobile app:create [NAME] [TEMPLATE]`

Create a shiny new mobile application

```
USAGE
$ mobile app:create [NAME] [TEMPLATE]

ARGUMENTS
NAME Name of your project
TEMPLATE Template to use for creating your new app

OPTIONS
-c, --copyright=copyright Copyright for your project
-d, --description=description Description for your project
-g, --guid=guid GUID for your project
-i, --id=id ID for your project
-l, --license=license [default: MIT] Specifies the license for the project
-n, --name=name Name of your project
-p, --path=path Specifies the directory where you want to initialize the project
-p, --publisher=publisher Name of person/company publishing app
-t, --template=template Template to use for creating your new app
-u, --url=url URL for your project
--author_email=author_email Specifies the email address of the Author
--author_name=author_name Specifies the full name of the Author
--author_url=author_url Specifies the URL for the Author
--bugs_email=bugs_email Email address for submitting issues/bugs
--bugs_url=bugs_url Specifies the URL for submitting issues/bugs
--github_username=github_username Specifies the github username for the project
--repo_url=repo_url Specifies the URL for the repo

DESCRIPTION
...
Create a new mobile app from a template using all sorts of nifty options!

Tool will create an app using values from parameters or from the user config file which is located here:
~/.config/@geek/mobile/config.json
Future versions of the tool will allow setting config values from CLI.

EXAMPLES

undefined

undefined my-app-name [@scope/]
undefined my-app-name [@scope/]@
undefined my-app-name [@scope/]@
undefined my-app-name [@scope/]@

undefined

undefined my-app-name :/
undefined my-app-name :/#
undefined my-app-name :/#
undefined my-app-name

undefined

undefined

undefined my-app-name
undefined my-app-name

undefined

undefined my-app-name
```

_See code: [src/commands/app/create.js](https://github.com/brentonhouse/geek-mobile/blob/v1.0.5/src/commands/app/create.js)_

## `mobile help [COMMAND]`

display help for mobile

```
USAGE
$ mobile help [COMMAND]

ARGUMENTS
COMMAND command to show help for

OPTIONS
--all see all commands in CLI
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.0/src/commands/help.ts)_

## `mobile which COMMAND`

show which plugin a command is in

```
USAGE
$ mobile which COMMAND
```

_See code: [@oclif/plugin-which](https://github.com/oclif/plugin-which/blob/v1.0.3/src/commands/which.ts)_

# Roadmap

- [x] **app:create -** Create a new mobile app project from templates
- [ ] **app:build -** Build iOS/Android mobile apps
- [ ] **app:run -** Run mobile app on simulator or device
- [ ] **app:clean -** Clean up build artifacts from project
- [ ] **resource:icons -** Manage iOS/Android icons for app
- [ ] **resource:images -** Manage images for mobile project
- [ ] **resource:splashes -** Manage images for mobile project
- [ ] **config:user -** Get/Set properties in user config file
- [ ] **config:project -** Get/Set properties in project config file
- [ ] **alias:create -** Create an alias for executing multiple commands with optional parameters
- [ ] Optional prompting for parameters
- [ ] User configuration file
- [ ] Project configuration file