Skip to content

Latest commit

 

History

History
89 lines (46 loc) · 4.1 KB

README.md

File metadata and controls

89 lines (46 loc) · 4.1 KB

Volusion-AngularJS Theme

Volusion theme for the AngularJS Framework

Build Status Dependency Status Views Built with Grunt

Introduction

You can use any front-end framework or libraries you want on the Volusion platform, as long as you interface with the Volusion API. This AngularJS theme project, however, has been created in aim to streamline the design and development of themes available in the Volusion theme store. This project is intended to get you up and running in no time, so you can focus on what matters most.

Getting started

First, you need a GitHub account. A free account will do you just fine.

Installation

Next, unless you're a git wizard (a gizard?), you'll want to also install a git client. There are a number to choose from, but the official GitHub ones are actually pretty nice.

Windows Pro Tip: In the GitHub for Windows client, select Tools >> Options and change your default shell to Git Bash. Select your project, hit the Tools and Options button and then "open a shell here" or just hit the back tick key ``` as a shortcut. You now have an excellent Git shell with your Git credentials already stored.

Another Windows Pro Tip: Add "C:\Users\xxx\AppData\Local\GitHub\PortableGit_xxx\bin" to your PATH user environment variable to gain access to common *nix commands in your Windows Command Prompt without installing msysgit or cygwin.

See also: Set Up Git · GitHub Help

Fork it

If you scroll all the way to the top of this page, you'll see a Fork button. Click it! After a moment, you will be forwarded to your fork of this project. That's it!

See also: Fork A Repo · GitHub Help

Clone it

Now, in the right pane, you'll see a "Clone in Desktop" button. Click it! Your git client will be started and the cloning process will start.

See also: Fork a Repo, Step 2: Clone your fork · GitHub Help

Create a branch

As a general practice, you want to stay off the main "master" branch of the repository. This means you'll need to create a new branch for your theme and work on top of that.

In the client

Click the branch button at the top where it says "master" and type the name of your theme in the text box. Hit ENTER or click the "+ create branch: xxx" button to create and switch to your new branch.

In the shell

$ git checkout -b my-theme
Switched to branch 'my-theme'

To build

grunt serve (to develop and preview with livereload)

grunt build:dist (Build for production which hardcodes the API urls to relative paths of /api/v1/ so you won't be able to preview it)

grunt build:samplestore (or just "grunt" or just "grunt build" to build to dist which hardcodes the API urls to http://www.samplestore.io/api/v1/. Then to preview it you'll want to setup a web server to serve dist. We'd welcome a PR to support grunt serve:dist and eliminate the need for a seperate web server)

grunt build:mybox (this mybox alias you'll find in the gruntfile, which you can customize to build to a specific api, such as the merchant site you're designing the theme for)

License

TBD © Volusion, Inc.

Bitdeli Badge