Giter VIP home page Giter VIP logo

reactportfoliotemplate's Introduction

React Portfolio, multiple pages with dark mode

a portfolio for developers

screenshot

View Live Template | View Live Example

features

🌑 Dark Mode Toggler

📖 Multi-Page Layout

📱 Fully Responsive

🎨 Modern Design

💡 Perfect Lighthouse Score

screenshot of perfect lighthouse score


getting started

prerequisites

  • have Git installed on your machine
  • have Node.js installed on your machine
  • basic familiarity with your machine's command line
  • basic understanding of JSON data outline (arrays of objects basically)

how to use

  • fork the repository and clone locally
  • run npm install to install dependencies
  • once installation is complete, run npm run start to get your local copy running in the browser.

template instructions

1. replace the images

  • open the project in your file explorer, and navigate to src/img. there, you will see a bunch of images. these need to be replaced with your own images.

self.png

  • add an image of yourself with the background removed, and cropped into a square. i know this seems picky, but the template is set up in a way that this is how it will look best :) I recommend using https://remove.bg to remove the background from your image. Once you add it to this img folder, rename it to self.png (delete the old self.png so yours replaces it)
  • if background removal is not an option for you, any image you use will automatically be made into a circle. for this reason, square images without too tall of an aspect-ratio work best.
  • example with background removed:

  • example with background not removed:

mockups

  • add to the img folder up to 5 screenshots of projects you have completed to be added to your portfolio page. this can either be a regular screenshot, or you can create mockups like what are on the default template. I created these in Canva -- if you would like help with creating them for your own projects, feel free to message me on Twitter and I will happily help you make them :)

example:

  • to make life easier later, name these files mock1.png, mock2.png, etc.

2. edit Info.js

Next, open the project in your code editor. Navigate to src/info/Info.js. There are some instructions written in the comments there, but I will go over it all here as well:

Color Scheme

near the top of the file, you will find a line that looks like this:

export let colors = ["rgb(0,255,164)", "rgb(166,104,255)"];

There are the colors being used to determine the "accents" throughout the site - the circle behind your self portrait, the color of your name, the labels on the about page, and the underline for the navigation.

You can pick any colors you like for this, just play around with it and make sure to check the colors against both light mode and dark mode to make sure it looks good on both :)

Your Information

going further down the Info.js file, you can start replacing the default information with your own information, such as first name, last name, initials, position, etc. Some of the values in this file should remain untouched -- be sure to read the comments to see what to edit.

if you're not sure how to get emojis for the miniBio and hobbies, on Mac you should be able to access the emoji keyboard with ctrl+cmd+space, and on Windows with windows+period('.')

Otherwise, use Emojipedia to find and copy-paste what you like.

For the 'socials' section, be sure to replace the links with your own social profile links.

For the 'portfolio' section, update the titles to whatever you want. The live link should be a link to the live demo of your project. The source link should be a link to the repository where the code of the project is hosted, such as GitHub.

Note: If you have more than 5 projects, you will need to add more objects to the portfolio array. Just copy from the opening bracket to the comma of one object and continue pasting as many as you need. If you need help with this, feel free to reach out.

And that's it! If you save the file and check your live server, you should see that the information has been updated and the portfolio has been customized.

Now, you can commit and push your changes to your forked repository, and deploy however you like.


And you're done!

If you have any questions or issues with the setup process, feel free to contact me by any of the means below:

Twitter | [email protected]

Or, use this repo and post an "issue" :)

All that I ask is that you please credit me for the template :) If you'd like to remove the credit from the bottom of the site, go for it, just link my profile somewhere in your ReadMe when you deploy, or wherever.

.•° ✿ °•.

If you enjoyed this template and want to support my ability to make more of these, as well as creating video tutorials about React projects, writing articles about helpful developer tools, or you just want to be nice, feel free to support me on Ko-Fi!

If you have any suggestions for how to improve this template, the ReadMe guide, etc. please don't hesitate to reach out -- I will always happily accept constructive feedback!

°•. ✿ .•°


examples of people using this template!

1

2

3

4

5

6

7

8

9

10

11

reactportfoliotemplate's People

Contributors

dependabot[bot] avatar paytonjewell avatar yusufboran avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.