Merge pull request #164 from arifszn/133-local-setup
Add guide for setting up locally
This commit is contained in:
commit
2e0603d52b
26
README.md
26
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 <a href="https://www.npmjs.com/package/@arifszn/gitprofile">NPM</a>.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user