ilia/profile
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #164 from arifszn/133-local-setup

Browse Source 
Add guide for setting up locally
This commit is contained in:
Ariful Alam 2022-09-09 00:04:40 +06:00 committed by GitHub
commit 2e0603d52b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -75,9 +75,10 @@ Or try it **[online](https://stackblitz.com/edit/gitprofile)**.
## 🛠 Installation & Setup ## 🛠 Installation & Setup
There are two ways to use **GitProfile**. Use either one. There are three ways to use **GitProfile**. Use any.
- Forking this repo - Forking this repo
- Setting up locally
- Installing as package - Installing as package
### Forking this repo ### 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. 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 ### Installing as package
You can also use **GitProfile** by installing as an NPM package. First Install **GitProfile** via <a href="https://www.npmjs.com/package/@arifszn/gitprofile">NPM</a>. You can also use **GitProfile** by installing as an NPM package. First Install **GitProfile** via <a href="https://www.npmjs.com/package/@arifszn/gitprofile">NPM</a>.