Skip to content

Quasar SSR ⚑ deployed on DigitalOcean πŸ„ using NGINX and PM2.

License

Notifications You must be signed in to change notification settings

Mary-Tyler-Moore/venues-production

Repository files navigation

Star Power ✨

If you like my work please star ⭐ the repo.


πŸŽ₯ venues-production 🎬

Quasar SSR ⚑ deployed on DigitalOcean πŸ„ using NGINX and PM2.




View Demo Β· View 360 Panoramas Β· Report Bug Β· Request Feature


Tech Stack

Check out the other tech stacks I use at Stack Share


Motivation: πŸƒ πŸ’¨ ❗ πŸ…

Working with Quasar CLI has been a game changer for my development and deployment work flow. This README documents the deployment of a Quasar SSR build on DigitalOcean using PM2 and NGINX.


Quasar Framework

Quasar Framework logo

Build responsive Single Page Apps, SSR Apps, PWAs, Hybrid Mobile Apps and Electron Apps, all using the same codebase!, powered with Vue.


πŸ’° Supporting Quasar

Quasar Framework is an MIT-licensed open source project. Its ongoing development is made possible thanks to the support by these awesome backers.

Please read our manifest on Why donations are important. If you'd like to become a donator, check out Quasar Framework's Donator campaign.


πŸ”Ž Useful Resources:

Chat Support

Ask questions at the official community Discord server: https://chat.quasar.dev

Community Forum

Ask questions at the official community forum: https://forum.quasar.dev

Stay in Touch

For latest releases and announcements, follow on Twitter: @quasarframework

Join Quasar on Discord:

Quasar on Github:

Documentation

Head on to the Quasar Framework official website: https://quasar.dev




πŸš€ To-do:

  • Write README.md
  • Replace placeholder images with gifs
  • Setup Prettier
  • Clean up folder structure
  • Create 1 template card to replace the cards used for each room
  • Move hard coded data from cards to external JSON file
  • Move all project example images to Cloudflare CDN.
  • Update contact page



πŸ“† Project History

Performance Improvements


Before:

SPA Build deployed on LAMP stack


After:

SSR Build deployed on DigitalOcean using PM2 and NGINX as server proxy


πŸ”Œ Install NetData:

NetData is distributed, real-time, performance and health monitoring for systems and applications. Netdata is free, open-source software and it currently runs on Linux, FreeBSD, and MacOS, along with other systems derived from them, such as Kubernetes and Docker.


πŸ“ˆ Server Performance

httperf

httperf is a tool πŸ”¨ for measuring web server performance. It provides a flexible facility for generating various HTTP workloads and for measuring server performance.

Load Testing Server (WIP)

I am developing a test to demonstrate the load on our servers at the start (3,000 concurrent connections) of a University Football 🏈 Game. We see the largest amount of traffic 15 minutes before the game begins, and half time when the fans are using our Login Portal to access the free WiFi service my company provides at the games.


🎨 UI/UX Improvments:

Mobile UI:

Mobile Menu:

Mobile Room Details:


Table of Contents

πŸ’Ώ About The Project

🌎 i18n:

Traduzco del inglΓ©s al espaΓ±ol.

src/i18n/en-us/index.js

src/i18n/es/index.js

Built With

  • Quasar
  • VueJS
  • SCSS

Project Features

  • i18n
  • a11y
  • Vuex
  • Dark Mode
  • SSR Deployment Guide (Currently a WIP)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
npm install npm@latest -g

πŸ”Œ Installation

  1. Clone the repo
git clone https://github.com/Mary-Tyler-Moore/venues-production.git
  1. Install NPM packages
npm install

πŸ”¨ Build the app for production

quasar build -m ssr

Add Icon-Genie Extension

quasar ext add @quasar/icon-genie

:neckbeard: Node.js Deployment (Currently a WIP!)

Steps to deploy a Node.js app to DigitalOcean using PM2, NGINX as a reverse proxy and an SSL from LetsEncrypt

1. Sign up for Digital Ocean πŸ„

If you use the referal link below, you get $10 free (1 or 2 months) https://m.do.co/c/5424d440c63a

2. Create a droplet and log in via ssh πŸ’»

I will be using the root user, but would suggest creating a new user

3. Install ‡️ Node/NPM

curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -

sudo apt install nodejs

node --version

4. Clone your project from Github :octocat:

There are a few ways to get your files on to the server, I would suggest using Git

git clone yourproject.git

5. Install dependencies and test app

cd yourproject
npm install
npm start (or whatever your start command)
# stop app
ctrl+C

6. Setup PM2 process manager to keep your app running πŸƒ πŸ’¨ ❗ πŸ…

sudo npm i pm2 -g
pm2 start app (or whatever your file name)

# Other pm2 commands
pm2 show app
pm2 status
pm2 restart app
pm2 stop app
pm2 logs (Show log stream)
pm2 flush (Clear logs)

# To make sure app starts when reboot
pm2 startup ubuntu

You should now be able to access your app using your IP and port. Now we want to setup a firewall blocking that port and setup NGINX as a reverse proxy so we can access it directly using port 80 (http)

7. Setup ufw firewall

sudo ufw enable
sudo ufw status
sudo ufw allow ssh (Port 22)
sudo ufw allow http (Port 80)
sudo ufw allow https (Port 443)

8. Install NGINX and configure

sudo apt install nginx

sudo nano /etc/nginx/sites-available/default

Add the following to the location part of the server block

    server_name yourdomain.com www.yourdomain.com;

    location / {
        proxy_pass http://localhost:5000; #whatever port your app runs on
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_cache_bypass $http_upgrade;
    }
# Check NGINX config
sudo nginx -t

# Restart NGINX
sudo service nginx restart

You should now be able to visit your IP with no port (port 80) and see your app. Now let's add a domain

9. Add domain in Digital Ocean

In Digital Ocean, go to networking and add a domain

Add an A record for @ and for www to your droplet

Register and/or setup domain from registrar

I prefer Namecheap for domains. Please use this affiliate link if you are going to use them https://namecheap.pxf.io/c/1299552/386170/5618

Choose "Custom nameservers" and add these 3

  • ns1.digitalocean.com
  • ns2.digitalocean.com
  • ns3.digitalocean.com

It may take a bit to propogate

10. Add SSL with LetsEncrypt

sudo add-apt-repository ppa:certbot/certbot
sudo apt-get update
sudo apt-get install python-certbot-nginx
sudo certbot --nginx -d yourdomain.com -d www.yourdomain.com

# Only valid for 90 days, test the renewal process with
certbot renew --dry-run

Now visit https://yourdomain.com and you should see your Node app

Usage

I hope this is useful to anyone working with Quasar and VueJS. I'd also like to provide an easy way for folks to share 360 panoramas.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the Creative Commons BY-NC-SA License. See LICENSE for more information.

Acknowledgements