Everhoof Instant Messaging System

Requirements

• Node 14

Build Setup

# install dependencies
$ yarn --frozen-lockfile

# serve with hot reload at localhost:3000
$ yarn dev

# build for production and launch server
$ yarn build
$ yarn start

# generate static project
$ yarn generate

To automatically create new component from template run:

$ yarn mc component-name

Before commit and push run:

$ yarn format
$ yarn lint

To download the current api schema and generate types run:

$ yarn typegen

Prepare for deployment

Create folders for app

$ mkdir -p /path/to/production/folder
$ mkdir -p /path/to/staging/folder

Create Secrets in GitHub Actions:

For staging

• STAGING_SSH_HOST=127.0.0.1
• STAGING_SSH_PORT=22
• STAGING_SSH_USER=root
• STAGING_SSH_KEY=...
• STAGING_APP_DIR=/path/to/staging/folder
• STAGING_NODE_ENV=staging

For production

• PRODUCTION_SSH_HOST=127.0.0.1
• PRODUCTION_SSH_PORT=22
• PRODUCTION_SSH_USER=root
• PRODUCTION_SSH_KEY=...
• PRODUCTION_APP_DIR=/path/to/production/folder
• PRODUCTION_NODE_ENV=production

Manual run on server (optional)

$ cd $APP_DIR
$ export NODE_ENV=production
$ pm2 start

or

$ cd $APP_DIR
$ export NODE_ENV=staging
$ pm2 start