Updated the README

This commit is contained in:
Moorad
2019-10-21 12:26:02 +01:00
parent e21e0c11be
commit fa98112342

View File

@@ -1,9 +1,43 @@
## Youtube Downloader
# Youtube Downloader
This Project was used in one of my stories on Medium. If there is any issues please open a new issue.
This is a repository that has sample code for my [Medium Article](https://blog.usejournal.com/how-i-made-my-own-youtube-downloader-using-javascript-and-node-js-160b172f6e10)
## Getting Started
If there is any issues please open a new issue.
1. You need to clone this repository
```
git clone https://github.com/mooradal/youtubeDownloader
```
2. After you clone the repo you will have to navigate to the Server folder
```
cd Server
npm install
npm run dev
```
3. Then you will have to install all the packages and dependencies
```
npm install
```
4. Finally you need to run it
```
node index.js
```
5. If you want to use nodemon (nodemon is a package that will auto restart the server when files are changed) you can run **(Optional)**
```
npm run dev
```
or
```
nodemon index.js
```
## Info
If there is any issues please open a new issue. You are welcome to add pull requests at anytime
Thank you so much for supporting me and thank you for almost 2,000 claps. I really appreciate that. I will try to post more articles and I'm thinking of turning this project from a sample code to an actual functional public website for everyone to use!