Developer's Portfolio ✨

It is a personal static website/portfolio template hosted with GitHub Pages, built to showcase my recent projects.
Site URL / Demo » palkesh-baraiya.github.io/portfolio

About Me

Prerequisites

You should have Nodejs and Git installed on your PC. You should also own a GitHub account.

Setup

Fork this repoistory and clone it to your local machine.

  git clone https://github.com/<your-username>/portfolio.git

Edit the config/config.js file. Replace config/profile.png with your image.

Note: You need to rename your image file as profile.png.
Run following scripts in terminal/command prompt to install dependencies.
```
  npm install
  npm run build
```

Testing

To test on your local server, run the following command:
```
  npm run dev
```
Open the browser to http://localhost:3000/

Deployment

If it works locally, you can deploy your project to GitHub Pages. GitHub Pages provides two types of free domains, <username>.github.io and <username>.github.io/<repository>. You can choose the one that suits your needs. You can learn more about domain types from here.

Deploy to <your-username>.github.io/portfolio

Simply you just need to commit and push your changes to github. And GitHub Actions will take care of the deployment. Your site will be available at https://<your-username>.github.io/portfolio

Deploy to <your-username>.github.io

Create a new repository with your username as <your-username>.github.io. And let the following command do the job for you.

  npm run predeploy
  node scripts/pages.js <your-username> master

Your site will be available at https://<your-username>.github.io

Note: You need to replace <your-username> with your username. To add CNAME for custom domain, see scripts/cname.js

License

Distributed under the MIT License. See LICENSE for more information.

palkesh-baraiya/portfolio