Getting Started

This section will help you run a local version of the author; useful for contributing to this project!

Tools we use

Below is a list of the software you'll need to download and install before continuing:

• A source code editor. We use Visual Studio Code, but feel free to use one you're most comfortable with.

• Git

  A version control system (VCS) for tracking changes in computer files and coordinating work on those files among multiple people.

• Node.js

  Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine. Node.js uses an event-driven, non-blocking I/O model that makes it lightweight and efficient. Node.js' package ecosystem, npm, is the largest ecosystem of open source libraries in the world.

Github and Fork

Now that you've got all the required software installed, you'll want to make an account on github.com (if you haven't already done so). Once signed in, fork this project so you have your own copy.

Setting up the environment

Next we'll install some node.js packages, clone your forked copy of this project, and get it ready to be run locally on your machine.

1. First, open git bash, or a command terminal where git is installed
2. Change your current working directory to one where you'd like to store this project
3. Run the following commands:
   • git clone git@github.com:(YOUR GITHUB USERNAME)/fgpa-apgf.git
   • git remote add upstream https://github.com/fgpv-vpgf/fgpa-vpga.git
   • git fetch --all
   • git checkout develop
   • npm install

Running a local copy

Using the command npm run serve, you can now open your preferred browser and navigate to http://localhost:6001/samples/fgpv-author.html. You should see the author loading on your screen.

Useful Commands