/web

Online real-time tutoring platform

Primary LanguageVue

UPchieve web client

Online tutoring platform built with Vue.js and Webpack

CircleCI

Build Setup

  1. Install NodeJS either via binary or Homebrew (brew install node)

  2. Run the following command to get the version number of both NPM and Node. Node has to be >= 11.7.0 and NPM has to be >= 6.0.0 for this project.

# Get NPM version
npm -v 

# Get Node version 
node -v

Note: if either of the following errors occur, add Node and NPM to your $PATH and restart the command prompt.

  • 'node' is not recognized as an internal or external command, operable program or batch file
  • npm' is not recognized as an internal or external command, operable program or batch file
  1. Clone the repository using HTTPS, SSH, or a git client like Fork.
# HTTPS
git clone https://github.com/UPchieve/web.git

# SSH
git clone git@github.com:UPchieve/web.git
  1. Move into the repository folder:
cd web
  1. Install Node dependencies:
# install dependencies
npm install
  1. NPM commands (available to use in the web repository directory)
# serve with hot reload at localhost:8080
npm run dev

# build for production with minification
npm run build

# run unit tests
npm run unit

# run e2e tests
npm run e2e

# run all tests
npm test
  1. See the web server repo for server installation

More information about our Vue setup: