Developer's Portfolio ✨

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

About Me · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Setup
3. Contributing
4. License

About The Project

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.

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 or emailing me at ameyswami2018@gmail.com for help configuring your project.

Setup

1. Fork this repoistory and clone it to your local machine.

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

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

   Note: You need to rename your image file as profile.png.

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

License

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