Giter Club home page Giter Club logo

react-resume-template's Introduction

React JS Resume Website Template

ReactJS Resume Website Template

GitHub release (latest by date including pre-releases GitHub top language GitHub Repo forks GitHub Repo stars GitHub package.json dependency version (prod) Github Repo Sponsors

React based template for software developer-focused resume websites

If this template has helped you and you'd like to support my work, feel free to ♥️ Sponsor the project

🎉 Version 2 is here! New features:

  1. Completely rebuilt with React and full typescript support
  2. Built on the Next.js framework for easy server side rendering/static generation, image optimization, api routes, and deployment
  3. Styled entirely with TailwindCss
  4. Re-organized data population file for customizing site.
  5. Significant improvement/modernization of all site sections

Looking for the old version? You can find it here.

Description

This is a React based personal resume website template. Built with typescript on the Next.js framework, styled with Tailwind css, and populated with data from a single file, you can easily create, customize and host your own personal website in minutes. Even better, the site is fully mobile-optimized and server-side rendered to ensure fast loading and a clean UI on any device. Read on to learn how to make it your own.

Make it Your Own!

1. Make sure you have what you need

To build this website, you will need to have the latest stable versions of Node and Yarn downloaded and installed on your machine. If you don't already have them, you can get Node here, and Yarn here.

2. Fork and download this repo (and star if you like!)

Next, find the Fork button in the top right of this page. This will allow you to make your own copy, for more info on forking repo's see here. After this, download to your development machine using the green Code button at the top of the repo page.

3. Install dependencies and run

Once you have your own copy of this repo forked and downloaded, open the folder in your favorite terminal and run yarn install to install dependencies. Following this, run yarn dev to run the project. In your terminal you should be given the url of the running instance (usually http://localhost:3000 unless you have something else running).

4. Customize the data to make it your own

All of the data for the site is driven via a file at /src/data/data.tsx. This is where you'll find the existing content, and updating the values here will be reflected on the site. If you have the site running as described above, you should see these changes reflected on save. The data types for all of these items are given in the same folder in the dataDef.ts file. Example images can be found at src/images/ and are imported in the data file. To change, simply update these images using the same name and location, or add new images and update the imports.

5. Hook up contact form

Due to the variety of options available for contact form providers, I've hooked up the contact form only so far as handling inputs and state. Form submission and the actual sending of the email is open to your own implementation. My personal recommendation for email provider is Sendgrid.

6. Make any other changes you like

Of course, all of the code is there and nothing is hidden from you so if you would like to make any other styling/data changes, feel free!

7. Deploy to Vercel and enjoy your new Resume Website

Deploying your new site to Vercel is simple, and can be done by following their guide here. When you're all done and the build succeeds, you should be given a url for your live site, go there and you'll see your new personal resume website! Congratulations!

Project Created & Maintained By

Tim Baker

GitHub followers

Stargazers

Stargazers repo roster for @tbakerx/react-resume-template

Forkers

Forkers repo roster for @tbakerx/react-resume-template

react-resume-template's People

Contributors

alminisl avatar chamrun avatar dependabot[bot] avatar dh4u avatar ggfevans avatar myersjac avatar tbakerx avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

react-resume-template's Issues

Missing .yarn folder

.Yarn plugin folder should be added to repo or you will get the following error:

31m[1mInternal Error[22m[39m: Cannot find module 'C:\Users[UserName]\Documents\GitHub\react-resume-template.ya
rn\plugins@yarnpkg\plugin-interactive-tools.cjs'
Require stack:
' C:\Users[UserName]\AppData\Local\node\corepack\yarn\3.6.1\yarn.js

Otherwise, you need to add instructions to:

  1. delete .yarnrc.yml
  2. yarn plugin import interactive-tools

Mobile Menu Scrolling to Home when clicked to hide

The issue is shown in the following gif:

ezgif-4-14d4543a522a

To correct it you can change the href for the "Hide Navigation" button in Header.js

Line 22 changes from this

<a className="mobile-btn"  href="#home" title="Hide navigation">Hide navigation</a>

To this:

<a className="mobile-btn"  href="#hide-nav-wrap" title="Hide navigation">Hide navigation</a>

How to deploy?

I updated to the latest version and deployed to my hosting (GoDaddy) but its not working. I had to change some relative paths for manifest.json and some css files in index.html and all console errors went away, but its still not loading any content. It like it doesnt have JS at all and I added a reference to jQuery Google API but that didnt work either. I am trying to understand how to deploy this to web hosting?

Additional nav link section formatting

Hey Tim, awesome website template thanks a mill! Trying to add additional sections and I can't figure out how to add them correctly so that they get the color change when selected/deselected. I know the function handler in init.js adds/removes the style class current to the section id but I can't figure out why it won't recognize the new section as a section or where all the sections are defined for the project. You can see exactly what I've tried here. Any help would be great thanks!

Something is broken `Module not found error with @headlessui/react in Header.tsx`

I've encountered a module not found error while trying to run the react-resume-template project after forking and installing the dependencies. The error is related to the @headlessui/react package and occurs in the Header.tsx component, which is used in the index.tsx page.

./node_modules/@headlessui/react/dist/headlessui.esm.js:2:0
Module not found: Can't resolve 'C:\My File\Open Source\react-resume-template\node_modules@headlessui\react\dist\components\transition\transition'

https://nextjs.org/docs/messages/module-not-found

Import trace for requested module:
./src/components/Sections/Header.tsx
./src/pages/index.tsx

Horizintal scroll

Hi! There is horizintall scroll in Chrome & Firefox on PC Windows. I caused by "w-screen" class. Just add max-width:100% to this class.

index.html question

First of all, Thanks for your awesome great work!!!

I want to change some contents in index.html, but

// is empty here ... Where can I find it and change the text? Thanks a lot~

Scrolling through testimonials on mobile

Hey! First of all, well done with this template. It looks amazing and the code is well structured and is easy to work with.

I'm having some issues with testimonials on the mobile. The "scrolling through testimonials" feature seems to be breaking the regular scrolling. So it's difficult to scroll up and down when you're on the testimonials section. You have to scroll on either of the sides of the testimonials.

Any idea on how I can improve this?

Cannot run `yarn dev`

Hello! I tried to run yarn dev as in the instruction, but the following error occurred:

(pwebsite) MacBook-Pro-15:personal-website sunweihao$ yarn dev
Usage Error: Couldn't find a script named "dev".

$ yarn run [--inspect] [--inspect-brk] [-T,--top-level] [-B,--binaries-only] [--require #0] <scriptName> ...

Is there something wrong with the yarn installation? Thanks!

Scrolling from Work to Testimonial section not smooth

@tbakerx I notice a slight delay when you scroll from the Work section to the Testimonial section on a clean pull of this repo inside a create-react-app. Any idea what could be causing this? It's like it hags for a split second when scrolling from the Work section to the Testimonial section.

Overflow Correction

Hi Tim,
I noticed that the horizontal overflow goes beyond the screen limit.

So, I simply updated this line, in line 14 of the Hero.tsx file:

Thank you!

Just wanted to say "Thanks!". I was looking for a simple solution for a personal portfolio page and stumbled across your solution. Furthermore I wanted to take a look at Next.js, so all boxes ticked ;-)

Issue in getting the resume pdf.

Tim,
there is no folder like assets/resume.pdf.
But how you pdf is getting downloded .I have no clue.
├───components
│ ├───Icon
│ ├───Layout
│ └───Sections
│ ├───Contact
│ └───Resume
├───data
├───hooks
├───images
│ └───portfolio
└───pages
└───api
Here is the tree of src

Something is broken

I forked this template (which looks very cool!), ran yarn install and then yarn dev as instructed and ...

src/pages/_app.tsx:10:8 - error TS2786: 'Component' cannot be used as a JSX component.
  Its element type 'ReactElement<any, any> | Component<any, any, any> | null' is not a valid JSX element.
    Type 'Component<any, any, any>' is not assignable to type 'Element | ElementClass | null'.
      Type 'Component<any, any, any>' is not assignable to type 'ElementClass'.
        The types returned by 'render()' are incompatible between these types.
          Type 'React.ReactNode' is not assignable to type 'import("/Users/davidgs/github.com/node_modules/@types/react/index").ReactNode'.
            Type 'ReactElement<any, string | JSXElementConstructor<any>>' is not assignable to type 'ReactNode'.
              Property 'children' is missing in type 'ReactElement<any, string | JSXElementConstructor<any>>' but required in type 'ReactPortal'.

10       <Component {...pageProps} />
          ~~~~~~~~~

  ../node_modules/@types/react/index.d.ts:181:9
    181         children: ReactNode;
                ~~~~~~~~
    'children' is declared here.

src/pages/index.tsx:20:6 - error TS2786: 'Page' cannot be used as a JSX component.
  Its element type 'ReactElement<any, any> | Component<PropsWithChildren<HomepageMeta>, any, any> | null' is not a valid JSX element.
    Type 'Component<PropsWithChildren<HomepageMeta>, any, any>' is not assignable to type 'Element | ElementClass | null'.
      Type 'Component<PropsWithChildren<HomepageMeta>, any, any>' is not assignable to type 'ElementClass'.
        The types returned by 'render()' are incompatible between these types.
          Type 'React.ReactNode' is not assignable to type 'import("/Users/davidgs/github.com/node_modules/@types/react/index").ReactNode'.

20     <Page description={description} title={title}>
        ~~~~

src/pages/index.tsx:21:8 - error TS2786: 'Header' cannot be used as a JSX component.
  Its element type 'ReactElement<any, any> | Component<{}, any, any> | null' is not a valid JSX element.
    Type 'Component<{}, any, any>' is not assignable to type 'Element | ElementClass | null'.
      Type 'Component<{}, any, any>' is not assignable to type 'ElementClass'.
        The types returned by 'render()' are incompatible between these types.
          Type 'React.ReactNode' is not assignable to type 'import("/Users/davidgs/github.com/node_modules/@types/react/index").ReactNode'.

21       <Header />
          ~~~~~~


Found 3 errors.

error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

I'm going to dig in and see if I can figure out what the problem is, and if I do, I'll submit a PR. Just thought you should know.

Heroku

How do you launch this app through heroku? Does it not have a proper back end?

Contact form

First of all, Thanks for your awesome great work!!!

Can u help me to send the value of forms in my mailbox ? Or if u have a better idea to work with this form ? Thanks a lot !!

NB: When I send the forms, there is infinite img and nothing behind to confirm this is sent or where

sorry for my english

ArQuel

resumeData

I am having the issue of the resumeData json file not linking to the rest of the webpage when I push it to the github repository. On my local server, the resumeData file is linked and filling in all of my data. There is just a problem with hosting on github. The error in the console says "Failed to load resource: /resumeData.json?_=1573576264900:1 the server responded with a status of 404 ()." Has anyone found the solution for this?

Can not download pdf document from resumen button

Good night from Spain!

First things first, thank you very much for your work! I'm using you code to learn typescript and at the same time I build a good resume website.

I raise this issue because I have tried to add a pdf in the "download resume button" (line 89 in src/data/data.tsx on main branch) but it still is reporting me an 404 error (404 This page could not be found.). The pdf exists in the specified path. But i do not find the problem in the code...

Thank you again!

Fernando...

Resolved: Small Typo

There is a small typo mistake on the demo landing page. In the description, it says "I'm a (Your City) based (Your Occupation Here)". It should be the other way around!

Also, thank you for this great template!

Update: I checked your personal site. I see that you meant "I'm a Victoria-based Software Security Engineer". You can delete or resolve this issue!

Update font awesome version

Hey, great job on this.

I wonder how is it possible to upgrade font awesome version from 4 to 5 since I want to add my "Dev.to" account and its icon is only supported in version 5+.

Many thanks in advance.

Portfolio section > item-wrap > img

Hello,

When I viewed the app on mobile, the website suddenly stretched out all the images in the portfolio section

Ps> it was deployed on firebase and netlify and still had the same issues

github
github2

Submit button - POST method

Hi,
First of all, Many thanks for your great work !
I have an issue calling the sendMail php (I have actually added my own php file - as it's not present in your package) function with a POST method.
with GET no problem.. but with the post I only get a 404 error.
Any ideas ?

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.