zouzhemike / pwa-christmas

Merry Christmas 2019

PWA Christmas

Overview

• Easiest way to run a node server: Sensible defaults & includes everything you need with minimal setup.

pwa-christmas is based on the following libraries & tools:

• express/mysql: Performant, extensible web server framework

Features

• PWA
• Notification
• Offline
• Install Homescreen
• Responsive Mobile
• Runs everywhere: Can be deployed via now, up, AWS Lambda, Heroku etc.

Getting Started

---

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

• Install Node LTS 8
  • Download: https://nodejs.org/en/download/

Installation

Install yarn as global packages if not npm install -g yarn

    yarn install

You can use npm. But I recommend usage yarn instead of npm

Usage

---

  yarn start || npm start

Server will start with port http://localhost:8080

  npm build || npm build

Server will start with port http://localhost:4500 and environment NODE_ENV is development with yarn dev or production with yarn production

By default application will run with environment development. If you want to specify environment, ex: testEnvironment. You modify on folder scripts part of package.json file as below:

• Current: "dev": "cross-env NODE_ENV=development nodemon --exec babel-node src/index.js",

• Change to: "dev": "cross-env NODE_ENV=testEnvironment nodemon --exec babel-node src/index.js",

Running the tests || Scan ESlint issues

up (Coming soon 🔜 )

Deployment

Heroku

To deploy your application server with Heroku, follow these instructions:

1. Download and install the Heroku Command Line Interface (previously Heroku Toolbelt)
2. Log in to the Heroku CLI with heroku login
3. Navigate to the root directory of your app server
4. Create the Heroku instance by executing heroku create
5. Deploy your app server by executing git push heroku master

up (Coming soon 🔜 )

AWS Lambda (Coming soon 🔜 )

Help & Community

Join me. if you run into issues or have questions. I love talking to you!