From 0a53136f1adb7b0ae630b056535414847b25e04d Mon Sep 17 00:00:00 2001 From: hak8or Date: Sat, 31 Mar 2018 00:53:16 -0400 Subject: [PATCH] Added readme --- readme.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index b6a3ec9..0b02e8f 100644 --- a/readme.md +++ b/readme.md @@ -1,10 +1,18 @@ # Frontend ## Description -Oh god, front end web development, specifically javascript. + +Oh god, front end web development, specifically javascript. This is the front end for the API based backend of DumbYT, a simple Youtube manager that keeps track of various channels or videos a user wants to be "subscribed" to. This project makes use of the following: -- Vuejs - Seemingly resonable javascript framework that's well documented and actively developed. +- **Vuejs** Reasonable javascript framework that's well documented and actively developed. +- **Axios** Nice HTTP post/delete/etc helper library +- **TypeScript** Making javascript more bearable, adds types to the language and other niceties. +- **WebPack** Handles running the Typescript compiler and minifying and running a server for development. +## Getting Started + +1. Clone the repository +2. Run ```npm update``` to download all the project dependencies. +3. Run ```npm serve``` which will automatically start a server and recompile the typescript based backend when there are file changes