kranzky / lets-punk

Are you ready to rock?

Let's Punk!

Template project for Punk! omakase web framework for rapid prototyping.

Setup

> brew bundle
> nvm use `cat .nvmrc`
> npm uninstall --global quasar-cli
> npm install --global @quasar/cli@1.1.3
> yarn install
> bundle install

Usage

> punk db create
> punk db migrate
> punk server
> punk worker
> quasar dev -m pwa

Code Style

> standardrb --fix
> npx standard --plugin vue '**/*.{js,vue}' --fix

Icon and Splash Screen

> yarn global add @quasar/icongenie
> icongenie generate --icon punk-icon.png --background punk-splash.png --mode pwa --splashscreen-icon-ratio 0 --skip-trim

Release Process

Create a new tag and release on GitHub to trigger ship workflow.

Heroku

> heroku labs:enable runtime-dyno-metadata --app app-name

Build

• Add the heroku/nodejs and https://github.com/challengee/heroku-buildpack-libsodium.git build packs

Services

• Sign up at https://userstack.com/
• Add USERSTACK_API_KEY to env/locals.sh, GitHub secrets and Heroku config vars
• Sign up at https://ipstack.com/
• Add IPSTACK_ACCESS_KEY to env/locals.sh, GitHub secrets and Heroku config vars
• Add MailGun, MemCachier, Papertrail, Sentry and Heroku Redis free Heroku add-ons
• Add MAILGUN_DOMAIN to Heroku config vars for a custom domain

Copyright

Copyright (c) 2021 Jason Hutchens. See LICENSE for further details.