Create Vulcan App

This is the repository for Vulcan boilerplate

Installation and Setup Instructions

Clone this repository. You will need node and npm installed globally on your machine. Before installing, you need a one file named gsap-bonus.tgz and put it into config/. Please contact a team member to get the install file.

Installation: npm install

To Run Test Suite: npm test

To Start Server: npm start

To Visit App: localhost:4000

Branch and PR Naming Conventions

We're naming our branch based on issue created. For example, if an issue is number #709, a branch would be named: issue-709

When opening a PR, it is important to follow a specific naming convention. For example, if an issue is named "Update README" with the issue number of #709, the title of the PR should be:

Update README. Closes #709

This does two things: 1) help us keep a proper, clean Git log, and, 2) allows Github to automate workflows. When this is successfully merged-back, the inclusion of the "Closes #709" bit will ensure the corresponding issue is also closed.

When merging, always prefer the "Squash-and-merge" strategy and please delete any associated comments that Github suggests if it is a PR comprised of multiple commits.