IsTheJack / duva

Dockerized universal Vue App boilerplate (Built on Nuxt)

DUVA

Dockerized universal Vue App is a Nuxt boilerplate with other awesome stuff

Running the app using docker

Just download the docker if you don't have it and run the command below:

Prerequisite: Docker

# Set the node, cypress dependencies, install project dependencies and start dev server
docker-compose up

Build Setup

# install dependencies (use only npm instead of yarn)
$ npm run install

# serve with hot reload at localhost:3000
$ npm run dev

# build for production and launch server
$ npm run build
$ npm start

# generate static project
$ npm run generate

Running the tests

# run unit/integration tests
npm run test

# run e2e (headless mode) tests
npm run e2e

Configuring CI/CD

QA Flow

CD (Heroku)

1. Create an app into Heroku
2. Set the stack to container (docker)

# Now the deploy will use docker container
# You can configure it into ~/heroku.yml
$ heroku stack:set container

It will be deployed on branch master update

CI (CircleCI)

1. Setup the CircleCI on your repository
2. Set the HEROKU_APP_NAME and HEROKU_API_KEY environment variables

It will be ran on PR creation

Google Analytics

1. Go to ~/plugins/ga.js and set your GA key.
2. Go to the puglins section at ~/nuxt.config.js and uncomment the GA value:

  /*
  ** Plugins to load before mounting the App
  */
  plugins: [
    //...

    // Before uncomment the google analytics plugin, setup the keys into '~/plugins/ga.js'
    // Look for ga('create', 'UA-XXXXXXXX-X', 'auto') line into '~/plugins/ga.js' file
    { src: '~plugins/ga.js', ssr: false }, // uncomment this line

    // ...
  ],

Sentry Javascript Error Tracking (on production)

1. Go to ~/plugins/sentry.js and set your keys.
2. Go to the puglins section at ~/nuxt.config.js and uncomment the Sentry value:

  /*
  ** Plugins to load before mounting the App
  */
  plugins: [
    // Before uncomment the sentry plugin, setup the keys into '~/plugins/sentry.js'
    '@/plugins/sentry', // uncomment this line

    // ...
  ],

Built on Nuxt Js

• Vue
• vuetifyjs
• Sass
• Jest
• PWA
• Universal APP (Server side rendering)
• Prettier / Lint / Husky
• Cypress preconfig
• Docker preconfig (Production mode)
• JavaScript Error Tracking - Sentry
• Follow the angular commit conversion
• CircleCI preconfig
• Google Analytics preconfig
• Heroku (Docker)

For detailed explanation on how things work, checkout Nuxt.js docs.