avasthii / developer-portfolio

An open source template you can utilise to make your own personal website!

Developer Portfolio

An interactive, innovative portfolio template for software developers!

Live Demo

This repository contain a simple one page HTML. CSS & JS based website template that you can utilise to host your own developer portfolio that too using GitHub Pages!

Getting Started

This is a github template repository so you can simply generate a new repository with the same structure by following the instructions here.

Tech Stack

• HTML
• CSS
• JavaScript
• Libraries Used
  • Bootstrap
  • Sketch.js
  • Popper
  • jQuery
    • Magnific Popup
    • jQuery Vaildate

How To Use

• Fork this repository and clone into your local system
• Start a http server in your local repository.
  • If you're new to this, just install a simple static server like http-server
  • You'll be able to view the website on your desired port, working as expected.
• Change the different variables in the template to customise it according to your needs!

Repository structure

• index.html: Contains all the HTML code meant for the website to function
• assets: Contains all the JS, CSS & Image files
  • css/style.css: Main stylesheet file for the website
  • js/script.js: Main JS file for the website: Contains menu event listeners and sketch.js implementation
  • js/sketch.min.js: Minified file for the sketch.js library
  • img/logo~: These are the logo files (dark/ light and a big file) meant for showcasing on the front. Recommended to have a transparent background for these png files.
  • img/company.jpg: This is for the About section of the website. You can add your company logo, personal photo etc. here for building out the page.
  • img/project~: These are background images for the cards inside the projects section. Please note that these are imported as background within the style.css rather than showing as images within the HTML.
• favicon.png: Logo image for the browser favicon
• apple-touch-icon-144-precomposed: Touch icon
• .gitignore: Specifies intentionally untracked files to ignore. Learn more about it here

License

This project is licensed under the terms of the MIT license.

Contribute!

Have an idea/ suggestion/ change to be made for this project? Make sure to raise an issue, start a pull request and notify @yashovardhan

For any questions, feel free to reach out to @yashovardhan on twitter anytime!