Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cobiwave/simplefolio
⚡️ A minimal portfolio template for Developers
https://github.com/cobiwave/simplefolio
css css3 html html5 javascript minimal-portfolio-template parcel parcel-bundler portfolio scss simplefolio template
Last synced: about 16 hours ago
JSON representation
⚡️ A minimal portfolio template for Developers
- Host: GitHub
- URL: https://github.com/cobiwave/simplefolio
- Owner: cobiwave
- License: mit
- Created: 2019-06-28T06:07:04.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-20T15:40:51.000Z (5 months ago)
- Last Synced: 2025-01-06T23:10:29.271Z (8 days ago)
- Topics: css, css3, html, html5, javascript, minimal-portfolio-template, parcel, parcel-bundler, portfolio, scss, simplefolio, template
- Language: SCSS
- Homepage: https://simplfolio.netlify.com
- Size: 16.2 MB
- Stars: 13,541
- Watchers: 64
- Forks: 5,772
- Open Issues: 78
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome - cobiwave/simplefolio - ⚡️ A minimal portfolio template for Developers (SCSS)
- StarryDivineSky - cobiwave/simplefolio
- jimsghstars - cobiwave/simplefolio - ⚡️ A minimal portfolio template for Developers (SCSS)
README
# Simplefolio ⚡️ [](https://github.com/cobiwave/simplefolio/blob/master/LICENSE.md)  
## A minimal portfolio template for Developers!
## Features
⚡️ Modern UI Design + Reveal Animations\
⚡️ One Page Layout\
⚡️ Styled with Bootstrap v4.3 + Custom SCSS\
⚡️ Fully Responsive\
⚡️ Valid HTML5 & CSS3\
⚡️ Optimized with Parcel\
⚡️ Well organized documentation
To view the demo: **[click here](https://the-simplefolio.netlify.app/)**
---
## Why do you need a portfolio? ☝️
- Professional way to showcase your work
- Increases your visibility and online presence
- Shows you’re more than just a resume
## Getting Started 🚀
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Prerequisites 📋
You'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [NPM](http://npmjs.com)) installed on your computer.
```
[email protected] or higher
[email protected] or higher
[email protected] or higher
```
Also, you can use [Yarn](https://yarnpkg.com/) instead of NPM ☝️
```
[email protected] or higher
```
---
## How To Use 🔧
From your command line, first clone Simplefolio:
```bash
# Clone the repository
$ git clone https://github.com/cobiwave/simplefolio
# Move into the repository
$ cd simplefolio
# Remove the current origin repository
$ git remote remove origin
```
After that, you can install the dependencies either using NPM or Yarn.
Using NPM: Simply run the below commands.
```bash
# 2022 Update - Fix Dependencies
$ npm audit fix
$ npm i @parcel/transformer-sass
# Install dependencies
$ npm install
# Start the development server
$ npm start
```
Using Yarn: Be aware of that you'll need to delete the `package-lock.json` file before executing the below commands.
```bash
# Install dependencies
$ yarn
# Start the development server
$ yarn start
```
**NOTE**:
If your run into issues installing the dependencies with NPM, use this below command:
```bash
# Install dependencies with all permissions
$ sudo npm install --unsafe-perm=true --allow-root
```
Once your server has started, go to this url `http://localhost:1234/` to see the portfolio locally. It should look like the below screenshot.
---
## Template Instructions:
### Step 1 - STRUCTURE
Go to `/src/index.html` and put your information, there are 5 sections:
### (1) Hero Section
- On `.hero-title`, put your custom portfolio title.
- On `.hero-cta`, put your custom button label.
```html
```
### (2) About Section
- On `![]()
` tag, fill the `src` property with your profile picture path, your picture must be located inside `/src/assets/` folder.
- On `
` tag with class name `.about-wrapper__info-text`, include information about you, I recommend to put 2 paragraphs in order to work well and a maximum of 3 paragraphs.
- On last `` tag, include your CV (.pdf) path on `href` property, your resume CV must be located inside `/src/assets/` folder.
```html
About me
This is where you can describe about yourself. The more you describe
about yourself, the more chances you can!
Extra Information about you! like hobbies and your goals.
View Resume
```
### (3) Projects Section
- Each project lives inside a `row`.
- On `
` tag with class name `.project-wrapper__text-title`, include your project title.
- On `
` tag with `loremp ipsum` text, include your project description.
- On first `` tag, put your project url on `href` property.
- On second `` tag, put your project repository url on `href` property.
---
- Inside `
` tag with class name `.project-wrapper__image`, put your project image url on the `src` of the `![]()
` and put again your project url in the `href` property of the `` tag.
- Recommended size for project image (1366 x 767), your project image must be located inside `/src/assets/` folder.
```html
...
Project Title
Lorem ipsum dolor sit, amet consectetur adipisicing elit. Excepturi
neque, ipsa animi maiores repellendus distinctio aperiam earum dolor
voluptatum consequatur blanditiis inventore debitis fuga numquam
voluptate ex architecto itaque molestiae.
See Live
Source Code
...
```
### (4) 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` property.
```html
```
### (5) Footer Section
- Put your Social Media URL on each `href` attribute of the `
` tags.
- If you an additional Social Media account different than Twitter, Linkedin or GitHub, then go to [Font Awesome Icons](https://fontawesome.com/v4.7.0/icons/) and search for the icon's class name you are looking.
- You can delete or add as many `` tags your want.
```html
...
...
```
### Step 2 - STYLES
Change the color theme of the website - (choose 2 colors to create a gradient)
Go to `/src/sass/abstracts/_variables.scss` and only change the values for this variables `$main-color` and `$secondary-color` with your prefered HEX color.
If you want to get some gradients inspiration I highly recommend you to check this website [UI Gradient](https://uigradients.com/#BrightVault)
```scss
// Default values
$main-color: #02aab0;
$secondary-color: #00cdac;
```
---
## Deployment 📦
Once you finish your setup. You need to put your website online!
I highly recommend to use [Netlify](https://netlify.com) because it is super easy.
## Others versions 👥
[Gatsby Simplefolio](https://github.com/cobiwave/gatsby-simplefolio) by [Jacobo Martinez](https://github.com/cobiwave)\
[Ember.js Simplefolio](https://github.com/sernadesigns/simplefolio-ember) by [Michael Serna](https://github.com/sernadesigns)
## Technologies used 🛠️
- [Parcel](https://parceljs.org/) - Bundler
- [Bootstrap 4](https://getbootstrap.com/docs/4.3/getting-started/introduction/) - Frontend component library
- [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
- **Jacobo Martinez** - [https://github.com/cobiwave](https://github.com/cobiwave)
## Status
[](https://app.netlify.com/sites/the-simplefolio/deploys)
## License 📄
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Acknowledgments 🎁
I was motivated to create this project because I wanted to contribute on something useful for the dev community, thanks to [ZTM Community](https://github.com/zero-to-mastery) and [Andrei](https://github.com/aneagoie)