Generate Your App

Getting Started with UGF

For new users, please use the Yeoman tool to generate your first app:

To install Yeoman and clone the UGF generator

#Install Yeoman
# Make sure both is installed globally
npm install -g yo
#Install UGF Generator
git clone https://github.com/a10networks/generator-ugf.git
cd generator-ugf
npm link

To generate your first project

# Create a new directory, and `cd` into it:
mkdir my-new-project && cd my-new-project

# Run the generator, and browser will open http://localhost:3000 automatically
yo ugf

Or you can use the following commands to boot up, build, and test your project

# Start for development
npm start # or

# Just build the dist version and copy static files
npm run build

# Run unit tests
npm test

Generate more

Generate a container

# cd my-new-project
yo ugf:container my/namespaced/container

Generate a component

# cd my-new-project
yo ugf:component my/namespaced/container

Generate a feature

# TO DO: generate a dashboard or a wizard or other apps
# yo ugf:dashboard my/namespaced/dashboard

Want to generate more?

To use more of the generator, please read generator-ugf Readme.md

Last updated

Was this helpful?