README

Table of Contents

• Details
• Requirements
• Installation
• Build
• Usage
• Testing
• Support
• Credits
• Suggestions

Details

Name

react video js

Description

The app that displays a video using the video.js package and that ask for the user to register on the app when they finishing viewing the teaser.

Author

Roberto Sousa beto.sousa22@gmail.com

Requirements

• Install Node.js
• Install MongoDB
• Install VS Code

Installation

• Install dependencies

yarn

• Start mongoDB locally

mongod

• Start the local project

yarn develop

Navigate to http://localhost:3000

##Build

Yarn Script	Description
start	Does the same as 'npm run serve'. Can be invoked with npm start
build	Full build. Runs ALL build tasks (build-sass, build-ts, tslint, copy-static-assets)
serve	Runs node on dist/server.js which is the apps entry point
watch	Runs all watch tasks (TypeScript, Sass, Node). Use this if you're not touching static assets.
test	Runs tests using Jest test runner
build-ts	Compiles all source .ts files to .js files in the dist folder
watch-ts	Same as build-ts but continuously watches .ts files and re-compiles when needed
build-sass	Compiles all .scss files to .css files
watch-sass	Same as build-sass but continuously watches .scss files and re-compiles when needed
tslint	Runs TSLint on project files
copy-static-assets	Calls script that copies JS libs, fonts, and images to dist directory
develop	Start the project with the dev options on

Testing

For this project, I chose Jest as our test framework. While Mocha is probably more common, Mocha seems to be looking for a new maintainer and setting up TypeScript testing in Jest is wicked simple.

Credits

• Some of the vector resources used on the UI where found here
• Icon made found here

Suggestions

• TSLint
• Code Spell Checker