From c6db709d491f9eff36359bb841a2553c6e52a660 Mon Sep 17 00:00:00 2001 From: motebaya Date: Tue, 2 Jan 2024 03:05:18 +0700 Subject: [PATCH] feat:docs --- README.md | 38 ++++++++++++++++++++++++++++++++------ 1 file changed, 32 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 27f2ecd..07d642a 100755 --- a/README.md +++ b/README.md @@ -90,15 +90,41 @@ additional: ### Setup Web Server: -- run server on local: +- Run on local server: ```bash - ❯ npm run start/dev + ❯ npm run dev +> tiktok-js@3.1.0 dev +> nodemon src/index.js +[nodemon] 3.0.1 +[nodemon] reading config ./package.json +[nodemon] to restart at any time, enter `rs` +[nodemon] or send SIGHUP to 1755830 to restart +[nodemon] ignoring: **/test/** **/trash/** +[nodemon] watching path(s): *.* +[nodemon] watching extensions: js +[nodemon] starting `node src/index.js` +[nodemon] forking +[nodemon] child pid: 1755843 +[nodemon] watching 60 files +app listening on port 3000 +``` + +then open url http://localhost:3000 in your browser. -> tiktok-js@2.1.1 start -> node ./index.js +- Deploying to vercel with [Vercel CLI](https://vercel.com/docs/cli), for the first time you need to login first with your vercel account. -App listening on port 3000 +```bash +❯ vercel --prod +Vercel CLI 33.0.1 +? Set up and deploy “./tiktok-js”? [Y/n] y +? Which scope do you want to deploy to? username +? Link to existing project? [y/N] n +? What’s your project’s name? tiktokjs-downloader +? In which directory is your code located? ./ +🔗 Linked to username/tiktokjs-downloader (created .vercel and added it to .gitignore) +🔍 Inspect: https://vercel.com/username/tiktokjs-downloader/ [7s] +✅ Production: https://tiktokjs-downloader--username.vercel.app [7s] ``` ### Demo: @@ -123,7 +149,7 @@ App listening on port 3000 - Web: - https://vecel.com + https://tiktokjs-downloader.vercel.app/ ## License