Getting Started

Fork and copy to your own repository

1. Fork the pendo-vuetify-app repository

2. Open Terminal

3. Create a bare clone of of the repository

• $ git clone --bare [email protected]:<your-user-name>/pendo-vuetify-app.git

4. Create a new repository

5. Mirror-push to the new repository.

• $ cd pendo-vuetify-app.git
• $ git push --mirror [email protected]:<your-user-name>/<your-new-repository>.git

5. Remove the temporary local repository you created earlier.

• $ cd ../
• $ rm -rf pendo-vuetify-app.git

6. Clone your new repository

Code in the app that needs to be updated

1. In the public/index.html file add your apps snippet inside the script tags

2. To add or change user data that will be used to identify the user is located in the src/user-data/user-data.json

3. In the Drawer.vue component

• teamEnvUrlAndSubLink computed property add your baseUrl and subId
• teamEnvUrlAndSub computed property add your teamEnv and subName

4. In the Footer.vue component

• teamEnvUrlAndSubLink computed property add your baseUrl and subId
• teamEnvUrlAndSub computed property add your teamEnv and subName

Run Locally

• Run npm install or yarn install if you use Yarn
• Run npm run dev or yarn serve to start a local development server

Fix linting errors (linting rules are WIP)

• Run npm run lint --fix

Deploy to github pages

1. In the vue.config.js update

  publicPath: process.env.NODE_ENV === 'production'
    ? '/<your-repository-name-here>/'
    : '/'

2. In the deploy.sh

#!/usr/bin/env sh

# abort on errors
set -e

# build
npm run build

# navigate into the build output directory
cd dist

git init
git add -A
git commit -m 'deploy'

git push -f [email protected]:<your-github-username>/<your-github-repository>.git master:gh-pages

cd -

3. In terminal you will need to run bash deploy.sh

• Your github page will be https://<your-user-name>.github.io/<your-repository-name>/