Skip to content

This NPM package can generate the Uberflip Marketplace app file structure and seamlessly push local changes to your app during the app development process.

uberflip-partners/uf-app-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

                    __                ___ __ __
             .--.--|  |--.-----.----.'  _|  |__.-----.
             |  |  |  _  |  -__|   _|   _|  |  |  _  |
             |_____|_____|_____|__| |__| |__|__|   __|
                                               |__|
                                                         __
.---.-.-----.-----.  .-----.-----.-----.-----.----.---.-|  |_.-----.----.
|  _  |  _  |  _  |  |  _  |  -__|     |  -__|   _|  _  |   _|  _  |   _|
|___._|   __|   __|  |___  |_____|__|__|_____|__| |___._|____|_____|__|
      |__|  |__|     |_____|

This package can generate the Uberflip Marketplace app file structure and seamlessly push local changes to your app during the app development process.

Installing

Using npm:

$ npm i uf-app-generator

Commands

buildDir

This command generates a folder structure and auto-populates this directory with:

  • Sample manifest.json with examples of every input available in the Marketplace
  • Scripts Directory that contains a .JS file with a conditional themeCheck to drop each Hub code version
  • Image Directory to store all assets
$  buildDir

$  ❕ Enter App Name?
$  > test-App

$  📁 'test-App' directory created!

$  📁 test-App/images folder created...
$  📄 Manifest populated...
$  📁 test-App/scripts folder created...
$  📄 Script files populated...

$  ❕ Do you want to commit to a GitHub repo? (Y/N)
$  >y

$  Enter git repository URL for initial commit
$  >https://github.com/lfriis/test.git

.
...git stuff...
.

$   Happy developing 🚀

buildDir

The following folder structure will be generated in your local directory from the buildDir command.

.
├── manifest.json
├── images
│   ├── assets
├── scripts
│   ├── app.js

pushDir

This command looks for local changes in current directory and seamlessly pushes changes to the Marketplace app.

$  ❕ Enter marketplace app ID
$  >123456

$  ❕ App Version
$  >v1

$  🔧  APP CONFIG  🔧
$  ID:      123456
$  Version: v1

$  Looking for changes in: 📂 /Users/friisl/Documents/uf-app-generator-test
$  Changes pushed!

--uf-version

Outputs current version of uf-app-generator package.

--uf-help

Outputs detailed information about available commands and how to contact the developer.

About

This NPM package can generate the Uberflip Marketplace app file structure and seamlessly push local changes to your app during the app development process.

Resources

Stars

Watchers

Forks