waitr-test

WIP test automation, from soup to nuts.

Getting Started

These instructions assume you're using a recent MacOSX.

Install nvm and node

See official nvm Install & Update Script Steps

Basic nvm installation steps

Creates .zshrc file if one is not already present

touch ~/.zshrc

Request and run nvm install script

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | zsh

Export nvm configs

export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"

After editing your shell's rc file, either restart your terminal session, or re-source the rc file, e.g.

source ~/.zshrc

Verify nvm is installed by outputting the version

nvm -v

If you haven't already, clone this repository locally:

git clone git@github.com:IP-Erin/waitr-test.git; cd waitr-test

Setup Visual Studio Code

Download and install VSCode
Open the cloned repository
Install Workspace Recommended Extensions

Running tests - TO DO

Required Variables: TO DO Optional Variables: TO DO

Architectual Landmarks - TO DO

Other Tooling

ESLint (Code Quality Linter)

npx eslint . # Check code quality of all files

Prettier (Code Style Linter)

Note: Format-on-save is setup during VSCode Setup and can be disabled (Settings -> Format On Save)

npx prettier --check . # Check code style of all files
npx prettier --write . # Check and update code style of all files

exc304/waitr-test