Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AnilSeervi/DevFolio
A Modern Portfolio Template for Developers with easy setup process documented(with hosting).
https://github.com/AnilSeervi/DevFolio
css developer-portfolio developer-portfolio-template devfolio html javascript minimal minimal-portfolio-template portfolio portfolio-website scss simple template
Last synced: 3 months ago
JSON representation
A Modern Portfolio Template for Developers with easy setup process documented(with hosting).
- Host: GitHub
- URL: https://github.com/AnilSeervi/DevFolio
- Owner: AnilSeervi
- License: mit
- Created: 2020-08-08T17:25:32.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-05T21:57:41.000Z (5 months ago)
- Last Synced: 2024-06-11T12:47:22.370Z (5 months ago)
- Topics: css, developer-portfolio, developer-portfolio-template, devfolio, html, javascript, minimal, minimal-portfolio-template, portfolio, portfolio-website, scss, simple, template
- Language: SCSS
- Homepage: https://devfolio.js.org
- Size: 14 MB
- Stars: 375
- Watchers: 4
- Forks: 125
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - AnilSeervi/DevFolio - A Modern Portfolio Template for Developers with easy setup process documented(with hosting). (SCSS)
README
⚡️ DevFolio ⚡️
[](https://github.com/AnilSeervi/DevFolio/blob/master/README.md)   
## A Modern Portfolio Template for Developers!
## Features
⚡️ Modern UI Design + Reveal Animations + Hover Effects\
⚡️ Well organized documentation\
⚡️ One Page Layout\
⚡️ Custom SCSS\
⚡️ Fully Responsive\
⚡️ Valid HTML5 & CSS3\
⚡ Fast and SEO Optimized
To view a demo example, **[Click Here](https://devfolio.js.org)**\
To view a live example, **[Click Here](https://anilseervi.github.io/Portfolio/)**\
To view live example repo, **[Click Here](https://github.com/AnilSeervi/Portfolio/)**
## Getting Started 🚀
Here's a **Complete Guide** to walk you through the process of setting your own Portfolio Website with this minimal template on your local machine as well as hosting it on GitHub.
### Prerequisites 📋
You'll need [VSCode](https://code.visualstudio.com/) and [Git](https://git-scm.com/) installed on your computer.
You'll also need these two extensions [Live Preview](https://marketplace.visualstudio.com/items?itemName=ms-vscode.live-server) and [Live Sass Compiler](https://marketplace.visualstudio.com/items?itemName=glenn2223.live-sass) installed in your VSCode. You will be automatically promted to install these extensions once you open this project in VSCode.
---
## How To Use 🔧
In VSCode, Open the terminal(Ctrl+\\ ) and clone the DevFolio Repo.
```bash
# Clone this repository
$ git clone https://github.com/AnilSeervi/DevFolio.git
# Go into the repository
$ cd DevFolio
# Remove current origin repository
$ git remote remove origin
```
And delete the [`.github`](./.github) folder as you don't need it.
Now Simply click on **Watch Sass** in the bottom status bar to watch all your `.scss` file chages and compile them to vanilla `.css`.
And also open `index.html`, right click inside the file and select _Show Preview_ to start a preview at `http://127.0.0.1:3000/`.
OR
Press Ctrl+Shift+P or F1 to Show Command Palette, Search for **Live Sass: Watch Sass** and turn it on. Also search for **Live Preview: Start Server** and turn it on. Doing this will watch all your Sass files for changes and will spin up a live server for you at `http://127.0.0.1:3000/`.
---
## Template Instructions
### Step 1 - STRUCTURE
Open [`index.html`](./index.html) and fill your information, there are 6 sections:
### Head Section
- Add a title to your Portfolio website within the `` tag.
- Add some keywords and description to your Portfolio website as directed in the [`index.html`](./index.html) file.
```html
[Your name here] | Developer
```
- Remove google analytics tag before pushing it to GitHub.
### Hero Section
- On `.hero-title`, put your custom title.
- On `.hero-cta`, put your custom button cta.
```html
```
### About Section
- On `![]()
` tag, fill the `src` attribute with your profile picture, your picture must be located inside [`assets/`](./assets) folder.
- Recommended size for your profile image is (_450 x 450px_).
- On `
` tag with class-name `.about-wrapper__info-text`, include information about you, I recommend to use 2 paragraphs in order to work well and a maximum of 3 paragraphs.
- On last `` tag, include your resume url on `href` attribute.
```html
About Me
Lorem ipsum dolor sit amet consectetur adipisicing elit.
Lorem ipsum dolor sit amet consectetur adipisicing elit.
View Resume
```
### Projects Section
- Each project lives inside `row` class.
- On `
` tag with class-name `.project-wrapper__text-title`, include your project title.
- On `
` tag with `loremp ipsum...` text, include your project information.
- On first `` tag, put your project url on `href` attribute.
- On second `` tag, put your project repository url on `href` attribute.
---
- Inside `
` tag with class-name `.project-wrapper__image`, put your project image url on the `src` of the `![]()
` and put again your project url on `href` attribute of `` tag.
- Recommended size for project image (_1366 x 767px_), your project image must live in [`assets/`](./assets) folder. You can remove the default images and replace them with yours.
```html
Projects
...
```
### Contact Section
- On `
` tag with class-name `.contact-wrapper__text`, include some custom call-to-action message.
- On `` tag, put your email address on `href="mailto:` attribute.
```html
```
### Footer Section
- Put your social media link on each `` links.
- If you have more social-media accounts, see [Font Awesome Icons](https://fontawesome.com/icons) to put the corresponding additional social icon classNames.
- You can delete or add as many `` links your want.
```html
...
...
```
### Step 2 - STYLES
Change the color theme of the website ( choose 2 colors to create a gradient ):
Go to [`style/base/_variables.scss`](./style/base/_variables.scss) and only change the values on these properties `$main-color` and `$secondary-color` to your prefered HEX color.
Save the `.scss` file so that the **Live Sass Compiler** extension compiles it to `.css`.
```scss
// Default values
$primary-color: #36d1dc;
$secondary-color: #5b86e5;
```
**NOTE**: I highly recommend to checkout gradients variations on [UI Gradient](https://uigradients.com/#Scooter)
---
- You can clear the README.md file and add you own readme to it.
- Also you don't need to push the [`style`](./style) folder, so you can add [`style`](./style) to [`.gitignore`](./.gitignore) file to ignore it while pushing it to the repo.
- Delete the file [`CNAME`](./CNAME) before you push it.
---
## Deployment 📦
- Head to your GitHub account and create a new repo. And set a new remote for our template repo.
Note: remote URL will be different.
```bash
# set a new remote
$ git remote add origin https://github.com/user.repo.git
```
- Now commit all your changes with a commit message and push the code to your newly created repo.
```bash
# commit changes
$ git commit -m 'created my portfolio'
# push the changes
$ git push -u origin master
```
- Refresh your repo page and head to the settings tab. Now scroll down till you see GitHub Pages. In the Source section select the branch to be master and save it!
- Voilà your Portfolio should be live at `https://username.github.io/repoName/`
## Technologies used 🛠️
- [Sass](https://sass-lang.com/documentation) - CSS extension language
- [ScrollReveal.js](https://scrollrevealjs.org/) - JavaScript library
- [Tilt.js](https://gijsroge.github.io/tilt.js/) - JavaScript tiny parallax library
## Authors
- **Anil Seervi** - [https://github.com/AnilSeervi](https://github.com/AnilSeervi)
## License 📄
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgments 🎁
I was motivated and inspired while learning [ZTM: Complete Web Developer](https://www.udemy.com/course/the-complete-web-developer-zero-to-mastery/) to create a simpler version of [simplefolio](https://github.com/cobidev/simplefolio) for those who didn't know node and packages.
---
Have Fun Creating Your Own Portfolio Website.
