🎓 Javascript frontend for openstax tutor
Switch branches/tags
Clone or download
Latest commit a084e4e Dec 11, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Create template-story.md Sep 27, 2018
bin bootstrap 4 updates Nov 9, 2018
coach lint fixes Nov 16, 2018
configs slim build by using transforms and stripping timezone Nov 20, 2018
docker run dev off dev Sep 11, 2018
exercises use debounce to avoid triggering setState to often on scroll Nov 27, 2018
jenkins fix artifact path Oct 19, 2018
screenshots update screenshots to reflect new bio2e styles Jun 7, 2018
script add comment noting how the file is generated Nov 24, 2018
shared Merge pull request #2450 from openstax/misc-upgrade-fixes Dec 12, 2018
tutor Merge pull request #2450 from openstax/misc-upgrade-fixes Dec 12, 2018
.codecov.yml re-enable coverage of test directories Feb 17, 2017
.dockerignore Add docker configs Sep 11, 2018
.editorconfig add editorconfig Jun 17, 2016
.eslintrc.js update configs Nov 9, 2018
.gitattributes store screenshots in lfs Feb 21, 2018
.gitignore remove package-lock.json Jan 3, 2018
.node-inspectorrc add working debugger and example control flow Feb 17, 2016
.nvmrc Adding accessibility audit script Aug 2, 2018
.travis.yml Attempt to skip git-lfs on Travis Apr 30, 2018
AUTHORS replace package.json "author" with AUTHORS file Aug 14, 2018
Brewfile add scripts Dec 30, 2017
CONTRIBUTING.md 🐛 fix link to main CONTRIBUTING.md file Aug 2, 2017
COPYRIGHT Update COPYRIGHT Feb 19, 2018
Dockerfile jenkinsfile for accessability-audit Sep 14, 2018
LICENSE 🎨 update license filename so GitHub recognizes it Apr 17, 2017
LICENSING move license files back to the repo root Aug 5, 2016
README-IE.md add steps to configure IE development Jul 11, 2018
README.md Update to reflect yarn Jul 6, 2018
babel.config.js fix specs, allow full import of lodash in test env Nov 20, 2018
docker-compose.override.yml run dev off dev Sep 11, 2018
docker-compose.yml use multistage build Sep 11, 2018
docker-quickstart.md use multistage build Sep 11, 2018
package.json fork and use youtube-player that supports playing in external window Nov 30, 2018
webpack.config.js convert task plan to screen Nov 21, 2018
yarn.lock update dayz with bugfix for negative dates Nov 30, 2018

README.md

tutor-js

build status Coverage dependency status dev dependency status

The Front-end code for Openstax Tutor related projects

Install

  1. install nvm
  • run nvm install in this directory to install and use the correct version of node
  • Alternatively: manually install the right version of node in ./.nvmrc
  1. install yarn
  2. Git Clone this repository to the directory of your choice
  • If you don’t have git installed you can install homebrew and then brew install git
  1. cd tutor-js move into the checked out directory
  2. yarn install
  3. yarn run serve <project> (where <project is one of tutor|coach|exercises)
  • Run the Tutor server as shown below

Development

  • npm run serve <project> starts up a local development webserver which rebuilds files when changed
  • npm test <project> runs unit tests for all projects
  • npm run coverage generates a code coverage report
  • npm run build <project> archive builds minified files for production

Use PORT=8000 npm start to change the default webserver port.

After local updates are made:

  1. stop npm start
  2. npm install
  3. restart npm start

Tutor Server

Using the sample API data only allows acting as a student and can't save data. For a more realistic development experience you'll also need to run the Tutor server

  1. Install Tutor Server as shown in its README file
  2. Start both the tutor-server Rails application and run npm run serve tutor in this project's directory
  3. Load http://localhost:3001 in your browser
  • Once you click login, the server will present a dev console that allows you to select a user
  1. And will then render the FE just as it appears in production