Added readme

This commit is contained in:
hak8or 2018-03-31 00:53:16 -04:00
parent bc8a603d4e
commit 0a53136f1a
1 changed files with 11 additions and 3 deletions

View File

@ -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