Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hashirshoaeb/portfolio

The personal website/portfolio of Hashir Shoaib. Built using Nextjs and Bootstrap5.
https://github.com/hashirshoaeb/portfolio

devfolio hacktoberfest personal-website portfolio portfolio-site portfolio-website template

Last synced: 13 minutes ago
JSON representation

The personal website/portfolio of Hashir Shoaib. Built using Nextjs and Bootstrap5.

Host: GitHub
URL: https://github.com/hashirshoaeb/portfolio
Owner: hashirshoaeb
License: mit
Created: 2021-07-08T16:22:13.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-12-24T12:30:48.000Z (29 days ago)
Last Synced: 2025-01-15T10:43:34.880Z (7 days ago)
Topics: devfolio, hacktoberfest, personal-website, portfolio, portfolio-site, portfolio-website, template
Language: JavaScript
Homepage: https://hashirshoaeb.github.io/portfolio
Size: 17.3 MB
Stars: 124
Watchers: 3
Forks: 182
Open Issues: 8
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

Developer's Portfolio ✨

It is a personal static website/portfolio template hosted with GitHub Pages, built to showcase my recent projects.

Site URL / Demo »
hashirshoaeb.github.io/portfolio

About Me
·
Report Bug
·
Request Feature

[![GitHub forks](https://img.shields.io/github/forks/hashirshoaeb/portfolio?style=for-the-badge)](https://github.com/hashirshoaeb/portfolio/network)
[![GitHub license](https://img.shields.io/github/license/hashirshoaeb/portfolio?style=for-the-badge)](https://github.com/hashirshoaeb/portfolio/blob/master/LICENSE)
[![Twitter Follow](https://img.shields.io/twitter/follow/hashirshoaeb?color=ffcc66&logo=twitter&logoColor=ffffff&style=for-the-badge)](https://twitter.com/hashirshoaeb)
[![Node Version](https://img.shields.io/static/v1?label=Node&message=16.16.0&color=026e00&style=for-the-badge)](https://nodejs.org)
[![npm Version](https://img.shields.io/static/v1?label=npm&message=8.11.0&color=cb0000&style=for-the-badge)](https://nodejs.org)

Table of Contents

About The Project

Getting Started
- Prerequisites
- Setup

Support my work

Contributing

License

# About The Project

[![Product Name Screen Shot](/READMEdocs/screenshot.gif)](https://example.com)

There are many portfolio website templates available on Github, however, I didn't find one that really suit my needs so I created this one. A simple, easy to configure, lightweight, and responsive static portfolio website.

I know one template doesn't fulfill everyone's needs. So I'll try adding more features in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue.

**Features**

- [x] Easy to configure
- [x] SEO friendly
- [x] Responsive
- [x] Lightweight
- [x] Linktree Page

**Built with** [Nextjs](https://nextjs.org/) & [Bootstrap5](https://getbootstrap.com).

# Getting Started

Building your own personal website from this project can take as little as 30 minutes. Follow the setup instructions below. Please feel free to reach out to me by filing an [issue](https://github.com/hashirshoaeb/portfolio/issues) or emailing me at [email protected] for help configuring your project.

## Prerequisites

You should have [Nodejs](https://nodejs.org/en/) and [Git](https://git-scm.com/downloads) installed on your PC. You should also own a GitHub account.

## Setup

1. Fork this repoistory and clone it to your local machine.
```sh
git clone https://github.com//portfolio.git
```

2. Edit the [config/config.js](https://github.com/hashirshoaeb/portfolio/blob/main/config/config.js) file. Replace [config/profile.png](https://github.com/hashirshoaeb/portfolio/blob/main/config/profile.png) with your image.
>Note: You need to rename your image file as `profile.png`.

3. Run following scripts in terminal/command prompt to install dependencies.
```sh
npm install
npm run build
```
## Testing

1. To test on your local server, run the following command:
```sh
npm run dev
```

2. 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, `.github.io` and `.github.io/`. You can choose the one that suits your needs. You can learn more about domain types from [here](https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites).

### Deploy to \.github.io/portfolio

Simply you just need to commit and push your changes to github. And [GitHub Actions](https://docs.github.com/en/actions/learn-github-actions/introduction-to-github-actions#overview) will take care of the deployment. Your site will be available at `https://.github.io/portfolio`

### Deploy to \.github.io

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

```sh
npm run predeploy
node scripts/pages.js master
```

Your site will be available at `https://.github.io`

>Note: You need to replace `` with your username. To add CNAME for custom domain, see [scripts/cname.js](https://github.com/hashirshoaeb/portfolio/blob/main/scripts/cname.js)

# Support my work

If you found this project valuable, please consider giving it a ⭐️ on GitHub. Your support keeps me motivated! If you'd like to further support my work, you can buy me a book. Thank you for your generosity!

# Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contribution you make would be **appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

# License

Distributed under the `MIT` License. See [LICENSE](https://github.com/hashirshoaeb/portfolio/blob/main/LICENSE) for more information.