React vitae Material theme

!npm !npm bundle size

react-vitae-material-theme is the Material Design theme for react-vitae.

Installation

You can install react-vitae-material-theme with NPM or Yarn.

npm install --save react-vitae @material-ui/core react-vitae-material-theme or yarn add react-vitae @material-ui/core react-vitae-material-theme

Peer dependencies

react-vitae-material-theme requires an installation of the latest version of react-vitae and Material-ui.

Usage

react-vitae-material-theme includes a main component to quickly create your resume and a set of smaller components to allow you to customize the resume.

$3

The Resume component is a ready made page that will build the entire resume from the valid resume.json file provided to it. It uses the various components exported by this package to create the resume.

``jsx harmony
import { Resume } from 'react-vitae-material-theme';

const App = () => ;
`

$3

The package exports individual components used as the building blocks for the main Resume component, feel free to import them. They need to be added inside of a ResumeProvider from react-vitae.

`jsx harmony
import React from 'react';
import { ResumeProvider } from 'react-vitae';
export {
Profiles,
Personal,
Skills,
Languages,
Interests,
References,
WorkList,
VolunteerList,
EducationList,
ProjectsList,
AwardsList,
PublicationsList,
} from 'react-vitae-material-theme';

export const App = () => (
{/ Include any of hte imported components here /}
);
`

Development

$3

The installation of dependencies is made from the monorepo's root using lerna, see the commands there for more information on dependencies.

$3

npm start will run a development server at http://localhost:1234 with hot module reloading.

$3

npm lint will run eslint in this package.

$3

npm test will run the tests in this packages.

$3

npm run build will build the package and create the built files in the dist folder.

npm run clean will clean the package, removing the cache, node_modules` and built resources.

$3

Publishing is done automatically through travis.