Skip to content

rjshkhr/cleanfolio

Repository files navigation

Cleanfolio

Cleanfolio is a portfolio template built with React. However, if you prefer a template built with HTML, CSS, and JavaScript, you can check out Cleanfolio Minimal.

Preview

Imgur

Live Demo

Instructions

Setup

git clone https://github.com/rjshkhr/cleanfolio
cd cleanfolio

If you use nvm or fnm, execute:

nvm install
nvm use

Or:

fnm install
fnm use

To install and launch the project, run these commands:

yarn
yarn start

How to Use

  • Open the public/index.html file and replace:

<title>John Smith</title> with <title>Your Name</title>.

  • Open the src/portfolio.js file and make the necessary changes.

  • Optionally, you can add an image or logo for each project in two ways:

    1. Local image

      • Put your image inside the public/images/ folder
      • In portfolio.js, just use the file name:
      image: "cleanfolio.png"
    2. Web image

      • If your image is already hosted online, just paste the URL:
      image: "https://example.com/my-logo.png"

Deployment

  • In the package.json file, update:

"homepage": "https://rjshkhr.github.io/cleanfolio"

to "homepage": "https://yourusername.github.io".

  • Push the changes to your repository.

  • To build and deploy, run the following commands:

yarn build
yarn deploy

License

MIT