UPchieve web client

Online tutoring platform built with Vue.js and Webpack

Contributing Guide

GITLAB

NOTE: Active development on this project has moved to https://gitlab.com/upchieve/subway, no more pushes should go straight to the Github repo.

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

3. 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

4. Move into the repository folder:

cd web

5. Install Node dependencies:

# install dependencies
npm install

6. 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

# build and start [Bundle Analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer)
BUNDLE_ANALYZER=1 npm run build

# run unit tests
npm run test

# run e2e tests
npm run e2e

# run linter
npm run lint

# remove node_modules & dist then reinstall
npm run clean-slate

7. See the web server repo for server installation

More information about our Vue setup:

• Vue CLI
• Vue style guide

Build Setup Docker Alternative

This can also be run with docker and no other software. Use these instructions to rebuild your image as you iterate. It is assumed that you have Docker installed and running.

1. Download the repository.

#Clone the repository
git clone https://github.com/UPchieve/web.git

2. Move into the repository

#Enter the repository
cd web

3. The below command will make the program visible at localhost:8080

#The first time this is run it may take a few minutes, but afterwards it should be faster. Rerun with each change to see updates
docker build -t upchieve/web . && docker run -it -p 8080:8080 --rm --name upchieve-web-prototype-1 upchieve/web