Git Product home page Git Product logo

react-cv-module's Introduction

React-CV

A Ready to use resume (CV) Component built by React, available for React/Gatsby and fully printable!

React-CV is fully customizable,responsive and printable CV / Resume component for React/Gatsby. You can easily create your fully printable and beautiful CV / Resume by passing necessary props to React-CV. If needed, It is possible to use your own component inside.

You can easily integrate it to your existing apps, if you don't want to build an app, just fork the repository and edit data.js inside example app and build it!

Live Demo

NPM JavaScript Style Guide

Preview Desktop / PDF

Live Demo

Features

  • Ready to use by forking or installing on NPM
  • Customizable
  • Printable
  • Responsive
  • One click deploy (On the way)
  • Inline edit (On the way)

How to install ?

npm install react-cv or yarn add react-cv

Basic Usage

import React, { Component } from 'react'

import CV from 'react-cv'

class Example extends Component {
  render () {
    return (
      <CV
        personalData={{
          name: 'John Doe',
          title: 'Senior Software Developer',
          image: 'https://bulma.io/images/placeholders/128x128.png',
          contacts: [
            { type: 'email', value: '[email protected]' },
            { type: 'phone', value: '+00 (123) 456 78 90' },
            { type: 'location', value: 'New York' },
            { type: 'website', value: 'example.com' },
            { type: 'linkedin', value: 'linkedin.com/in/notexists' },
            { type: 'twitter', value: 'twitter.com/404' },
            { type: 'github', value: 'github.com/404' }
        ]}}
        sections= {[{
          type: 'text',
          title: 'Career Profile',
          content: 'When I was child, I always want to be a developer.',
          icon: 'usertie'
        }]}
        branding={true} // or false to hide it.
      />
    )
  }
}

Advanced Usage & Prop List

React-CV only requires basic personal data to work. All other props are optional. Here are the complete list of props and descriptions.

List of Props

  • Personal Data

    Name of Prop: personalData Type: Object Schema:

    {
    name: 'String',
    title: 'String',
    image: 'String', // URL
    contacts: [ // Array of objects
        { // Single contact object
            type: 'String', // Available values ['email', 'phone', 'location', 'website', 'github', 'linkedin', 'twitter']
            value: 'String'
        }
    ]
    }
  • Sections (Experiences, Projects, Career Profile, Skills, ETC)

    Name of Prop: sections Type: Array Of Objects Schema of single object:

    {
    type: 'String', // Available values ['text', 'common-list', 'projects-list', 'tag-list']
    title: 'String',
    icon: 'String or SVG Icon', // Available values ['graduation', 'book', 'comments', 'tasks', 'archive', 'rocket', 'language', 'cubes', 'usertie'] or FontAwesome SVG Icon
    description: 'String',
    groups: [ // Array of Object, if type is only projects-list
        { // Schema of single group object
          sectionHeader: 'Company Name',
          description: 'Optional',
          items: [
            { title: 'Project', projectUrl: 'optional', description: 'Optional' },
          ]
        }
    },
    items: [ // Array of Objects(type:common-list) or Array of Strings(type:tag-list)
        {
              title: 'Some Conferences / 2019',
              authority: 'SomeConf',
              authorityMeta: 'Speaker',
              authorityWebSite: 'https://www.someconf.somesome',
              rightSide: 'test'
        }
    ]

Too Lazy to read documentation? See working versions in example:

Example App Code

Example Data Format With Full Types (Code)

Change Log

  • 1.2.0 : Print CSS improvements

License

MIT ยฉ sbayd

contributors

sbayd

robinknox

react-cv-module's People

Contributors

markmyt avatar mjmammoth avatar renovate-bot avatar renovate[bot] avatar

Stargazers

 avatar

Watchers

 avatar

react-cv-module's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

  • Replace dependency babel-eslint with @babel/eslint-parser 7.11.0
  • Replace dependency eslint-plugin-node with eslint-plugin-n 14.0.0
  • Replace dependency rollup-plugin-babel with @rollup/plugin-babel
  • Replace dependency rollup-plugin-node-resolve with @rollup/plugin-node-resolve
  • Update dependency bulma to v0.9.4
  • Update dependency classnames to v2.5.1
  • Update dependency eslint-config-standard to v17.1.0
  • Update actions/checkout action to v4
  • Update actions/setup-node action to v4
  • Update dependency @svgr/rollup to v8
  • Update dependency bulma to v1
  • Update dependency eslint to v9
  • Update dependency eslint-plugin-standard to v5
  • Update dependency gh-pages to v6
  • Update dependency rollup to v4
  • Update dependency rollup-plugin-node-resolve to v5
  • ๐Ÿ” Create all rate-limited PRs at once ๐Ÿ”

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

github-actions
.github/workflows/dependency_pr.yaml
  • actions/checkout v3
  • actions/setup-node v3
.github/workflows/main-ci.yaml
  • actions/checkout v3
  • actions/setup-node v3
  • actions/checkout v3
  • actions/setup-node v3
.github/workflows/release.yaml
  • actions/checkout v3
  • actions/setup-node v3
npm
package.json
  • @fortawesome/fontawesome-svg-core ^6.1.0
  • @fortawesome/free-brands-svg-icons ^6.1.0
  • @fortawesome/free-solid-svg-icons ^6.1.0
  • @fortawesome/react-fontawesome ^0.1.18
  • babel-plugin-macros ^3.1.0
  • bulma ^0.9.3
  • classnames ^2.3.1
  • eslint-config-react-app ^7.0.0
  • @svgr/rollup 6.2.1
  • babel-core 6.26.3
  • babel-eslint 10.1.0
  • babel-plugin-external-helpers 6.22.0
  • babel-preset-env 1.7.0
  • babel-preset-react 6.24.1
  • babel-preset-stage-0 6.24.1
  • cross-env 7.0.3
  • docz 2.4.0
  • eslint 8.14.0
  • eslint-config-standard 17.0.0
  • eslint-config-standard-react 11.0.1
  • eslint-plugin-import 2.26.0
  • eslint-plugin-node 11.1.0
  • eslint-plugin-promise 6.0.0
  • eslint-plugin-react 7.29.4
  • eslint-plugin-standard 4.1.0
  • gh-pages 3.2.3
  • react 17.0.2
  • react-dom 17.0.2
  • react-scripts 5.0.1
  • rollup 2.70.2
  • rollup-plugin-babel 3.0.7
  • rollup-plugin-commonjs 10.1.0
  • rollup-plugin-node-resolve 3.4.0
  • rollup-plugin-peer-deps-external 2.2.4
  • rollup-plugin-postcss 4.0.2
  • rollup-plugin-url 3.0.1
  • prop-types ^15.5.4
  • react ^17.0.0
  • react-dom ^17.0.0
  • node >=8
  • npm >=5

  • Check this box to trigger a request for Renovate to run again on this repository

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.