A web app that intends to enhance the watching experience of the CS50 video archive. Predominantly revolves around the YouTube API, with some additional functionality such as supported chaptering and video search.
The app takes advantage of nodejs, npm and npm scripts to build/run. To be able to perform these operations you are going to need the latest version of node installed on your machine. You can accomplish this in the following ways:
- Download and run the pre-built installer from their website
- OR Download and install from the CLI using a package manager
If you already have node installed then please make sure you are using at least the latest stable version
^4.x.x or more ideally
^6.x.x. You can check which version you have installed by running the command
Once you have the latest version of node installed you will need to clone this repo to your machine:
git clone email@example.com:cs50/player50.git
After cloning you need to navigate to the project folder and run the following command:
npm i && npm run build
If the installation process outlined above ran with no errors, then you are ready to start serving or developing the app! The following
npm script commands will enable you get started:
- To generate a static build, that is, to compile the source code into distributed code.
npm run build
- To serve the app, that is, to make available the latest build on localhost.
npm run serve
- To develop the app, that is, to rebuild project and live reload localhost on source code change.
npm run dev
It is worth noting the languages and technologies used throughout the project:
JSstrictly in ES6, bundled using
browserifyand transpiled using
HTMLabiding the latest
HTML5specification and encouraged use of custom tags.
SCSSsyntax that gets compiled and enhanced by
Linting is enforced using
eslint which inherits the
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request
TODO: Write history
TODO: Write credits
TODO: Write license