From e725ef9b5cf22ec2bd48eb2cfe8320532a86a4bf Mon Sep 17 00:00:00 2001 From: Ariful Alam Date: Fri, 9 Sep 2022 00:03:37 +0600 Subject: [PATCH] Add guide for setting up locally --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 98c8dee..3a35626 100644 --- a/README.md +++ b/README.md @@ -75,9 +75,10 @@ Or try it **[online](https://stackblitz.com/edit/gitprofile)**. ## 🛠 Installation & Setup -There are two ways to use **GitProfile**. Use either one. +There are three ways to use **GitProfile**. Use any. - Forking this repo +- Setting up locally - Installing as package ### Forking this repo @@ -114,6 +115,29 @@ If you wish to add a custom domain, no CNAME file is required. Just add it to yo As this is a Vite project, you can also host your website to Netlify, Vercel, Heroku, or other popular services. Please refer to this [doc](https://vitejs.dev/guide/static-deploy.html) for a detailed deployment guide to other services. +### Setting up locally + +- Clone the project and change directory. + + ```shell + git clone https://github.com/arifszn/gitprofile.git + cd gitprofile + ``` + +- Install dependencies. + + ```shell + npm install + ``` + +- Run dev server. + + ```shell + npm run dev + ``` + +- Finally, visit [`http://localhost:5173/gitprofile/`](http://localhost:5173/gitprofile/) from your browser. + ### Installing as package You can also use **GitProfile** by installing as an NPM package. First Install **GitProfile** via NPM.