vuetify-express-postgresql-starter

Code style

This project uses JavaScript Standard Style, enforced (so far only in the front end) by ESLint.

Use of ES6+ features in this project is encouraged.

Tech/framework used

• PostgreSQL
• express
• PM2
• webpack
• ESLint
• SuperAgent
• VueJS
• Vuetify

Prequisites

• PostgreSQL
• NodeJS
• PM2 (for production deployment)

Quickest Path to Up and Running

• Run make install to install dependencies and build the docker container.
• Run make dev to run the database, API, and UI in development mode.

Installation

Install NPM packages

cd evc
npm install
cd client
npm install

Install PM2 for production deployment

npm install -g pm2

Configuration

• JWT token configuration goes in app/config/auth.config.js
• Database configuration goes in app/config/db.config.js
• AWS configuration goes in app/config/aws.config.js
• Twilio configuration goes in app/config/twilio.config.js

Development

Running the server and client as separate processes gives the best development experience with hot reloading in the client app.

The client app is

• Configured in client/.env.development to use http://localhost:3000/api as the base API path when running in development
• Configured in client/.env.production to use /api as the base API path when built for production

Running the Server in Development

To run the express server in devepment mode on https://localhost:3000:

node .

express uses swagger to document the server's REST API. This can be viewed at http://localhost:3000/explorer

Running the Client in Development

To run the Vue client in development mode on http://localhost:8080

cd client
npm run serve

Preparing for Deployment

Acquire a standalone certificate from LetsEncrypt and create server/ssl-config.js with the following content:

const path = require('path')
const fs = require('fs')
const isProd = process.env.NODE_ENV === 'production'

exports.privateKey = isProd ? fs.readFileSync(path.join('/path/to/privkey.pem')).toString() : ''
exports.certificate = isProd ? fs.readFileSync(path.join('/path/to/cert.pem')).toString() : ''
exports.chain = isProd ? fs.readFileSync(path.join('/path/to/chain.pem')).toString() : ''
exports.fullchain = isProd ? fs.readFileSync(path.join('/path/to/fullchain.pem')).toString() : ''

Deploying for Production

When the server starts, /server/boot/client.js builds the client app by running npm run build in the client folder.

To start the server

node_modules/pm2/bin/pm2 start pm2.json --env production

To stop the server

node_modules/pm2/bin/pm2 kill

To monitor the server

node_modules/pm2/bin/pm2 monit

License

MIT © 2023 Alex Pepper