simplefolio README

The project's README from github.com/cobiwave/simplefolio. As one markdown file: README.md.

Simplefolio ⚡️ GitHub GitHub stars GitHub forks

A minimal portfolio template for Developers!

Simplefolio

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


Why do you need a portfolio? ☝️

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 and Node.js (which comes with NPM) installed on your computer.

[email protected] or higher
[email protected] or higher
[email protected] or higher

Also, you can use Yarn instead of NPM ☝️

[email protected] or higher

How To Use 🔧

From your command line, first clone Simplefolio:

# 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.

# 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.

# Install dependencies
$ yarn

# Start the development server
$ yarn start

NOTE: If your run into issues installing the dependencies with NPM, use this below command:

# 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.

Simplefolio


Template Instructions:

Step 1 - STRUCTURE

Go to /src/index.html and put your information, there are 5 sections:

(1) Hero Section

<!-- **** Hero Section **** -->
<section id="hero" class="jumbotron">
  <div class="container">
    <h1 class="hero-title load-hidden">
      Hi, my name is <span class="text-color-main">Your Name</span>
      <br />
      I'm the Unknown Developer.
    </h1>
    <p class="hero-cta load-hidden">
      <a rel="noreferrer" class="cta-btn cta-btn--hero" href="#about">
        Know more
      </a>
    </p>
  </div>
</section>
<!-- /END Hero Section -->

(2) About Section

<!-- **** About Section **** -->
<section id="about">
  <div class="container">
    <h2 class="section-title load-hidden">About me</h2>
    <div class="row about-wrapper">
      <div class="col-md-6 col-sm-12">
        <div class="about-wrapper__image load-hidden">
          <img
            alt="Profile Image"
            class="img-fluid rounded shadow-lg"
            height="auto"
            width="300px"
            src="assets/profile.jpg"
            alt="Profile Image"
          />
        </div>
      </div>
      <div class="col-md-6 col-sm-12">
        <div class="about-wrapper__info load-hidden">
          <p class="about-wrapper__info-text">
            This is where you can describe about yourself. The more you describe
            about yourself, the more chances you can!
          </p>
          <p class="about-wrapper__info-text">
            Extra Information about you! like hobbies and your goals.
          </p>
          <span class="d-flex mt-3">
            <a
              rel="noreferrer"
              target="_blank"
              class="cta-btn cta-btn--resume"
              href="assets/resume.pdf"
            >
              View Resume
            </a>
          </span>
        </div>
      </div>
    </div>
  </div>
</section>
<!-- /END About Section -->

(3) Projects Section


<!-- **** Projects Section **** -->
<section id="projects">
  ...
  <!-- Notice: each .row is a project -->
  <div class="row">
    <div class="col-lg-4 col-sm-12">
      <div class="project-wrapper__text load-hidden">
        <h3 class="project-wrapper__text-title">Project Title</h3>
        <div>
          <p class="mb-4">
            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.
          </p>
        </div>
        <a
          rel="noreferrer"
          target="_blank"
          class="cta-btn cta-btn--hero"
          href="#!"
        >
          See Live
        </a>
        <a
          rel="noreferrer"
          target="_blank"
          class="cta-btn text-color-main"
          href="#!"
        >
          Source Code
        </a>
      </div>
    </div>
    <div class="col-lg-8 col-sm-12">
      <div class="project-wrapper__image load-hidden">
        <a rel="noreferrer" href="#!" target="_blank">
          <div
            data-tilt
            data-tilt-max="4"
            data-tilt-glare="true"
            data-tilt-max-glare="0.5"
            class="thumbnail rounded js-tilt"
          >
            <img
              alt="Project Image"
              class="img-fluid"
              src="assets/project.jpg"
            />
          </div>
        </a>
      </div>
    </div>
  </div>
  <!-- /END Project -->
  ...
</section>

(4) Contact Section

<!-- **** Contact Section **** -->
<section id="contact">
  <div class="container">
    <h2 class="section-title">Contact</h2>
    <div class="contact-wrapper load-hidden">
      <p class="contact-wrapper__text">[Put your call to action here]</p>
      <a
        rel="noreferrer"
        target="_blank"
        class="cta-btn cta-btn--resume"
        href="mailto:[email protected]"
        >Call to Action</a
      >
    </div>
  </div>
</section>
<!-- /END Contact Section -->
<footer class="footer navbar-static-bottom">
  ...
  <div class="social-links">
    <a href="#!" target="_blank">
      <i class="fa fa-twitter fa-inverse"></i>
    </a>
    <a href="#!" target="_blank">
      <i class="fa fa-linkedin fa-inverse"></i>
    </a>
    <a href="#!" target="_blank">
      <i class="fa fa-github fa-inverse"></i>
    </a>
  </div>
  ...
</footer>

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

// 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 because it is super easy.

Others versions 👥

Gatsby Simplefolio by Jacobo Martinez
Ember.js Simplefolio by Michael Serna

Technologies used 🛠️

Authors

Status

Netlify Status

License 📄

This project is licensed under the MIT License - see the 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 and Andrei

simplefolio (cobiwave/simplefolio)

Searching Database…

这是什么?Simplefolio 是一个面向开发者的极简单页作品集模板:克隆下来,替换成你自己的内容,就能得到一个带现代界面、渐显动画和完全响应式布局的个人网站。
它是建站工具,还是需要自己改的代码?是需要自己动手改的代码:内容放在 /src/index.html 里,样式是在 Bootstrap 4 基础上自定义的 SCSS,全部由 Parcel 打包。没有后台管理面板,也没有可视化编辑器。
我怎么在自己电脑上把它跑起来?在命令行克隆仓库,用 NPM 或 Yarn 安装依赖,然后启动开发服务器('npm start' 会运行 Parcel),打开它给出的本地地址即可。
开始之前我需要装好哪些东西?需要 Git 和 Node.js(NPM 随 Node.js 一起安装);Yarn 也可以作为替代的包管理工具。其他东西,比如 Bootstrap 和 jQuery,都会随项目依赖一起装好。
安装过程中有什么坑吗?有两个小坑:用 Yarn 时必须在安装前先删掉 package-lock.json;如果 NPM 出问题,README 里提供了一个备用命令来解决。
我可以随意用它做自己的作品集吗?可以——它采用 MIT 许可证,你可以不受限制地使用、修改和发布网站。
它背后用了哪些技术?打包工具是 Parcel,样式用 Bootstrap 4 加自定义 Sass,渐显动画用 ScrollReveal.js,视差效果用 vanilla-tilt(Tilt.js);jQuery 和 Popper 随 Bootstrap 一起引入。
我怎么改配色方案?把你选的两个十六进制颜色设置为 /src/sass/abstracts/variables.scss 里的 $main-color 和 $secondary-color——主题渐变就是由这两个变量构成的。
Simplefolio 有其他版本吗?有——README 里链接了 Jacobo Martinez 做的 Gatsby 版本和 Michael Serna 做的 Ember.js 版本,如果你更喜欢那两个技术栈的话。
作者为什么要做这个项目?他想为开发者社区贡献一些有用的东西,并向 ZTM Community 和 Andrei 表示了感谢。
Creator
cobiwave
Size
16.6 MB
Stars
14.2K
Updated
CommitDec 27
Age
7y
Commits · 90 Days