Web Resume

Single Page Web Application for CVs in React

Web Resume is a single page web application for your Résumé. All you need to do is to write your data in cv.json and run the project. This project uses React for the frontend, and Babel and Webpack to transpile and bundle the app into a single page web application.

Usage

Setup

From the command line, run

$ git clone https://github.com/samlehman617/web-resume
$ cd web-resume
$ npm install

to install dependencies to setup the project.

Build

To build the project (to the dist dir), simply run

$ npm run build

from inside the project.

Run server

To run a local server, simply run

$ npm start

from inside the project.

Deploy to GitHub Pages

To use GitHub pages to host the SPA, create your own repo to host the project, enable Pages for the repo, and run

$ npm run deploy

from inside project, and follow the CLI instructions. The deployed project can be viewed at https://{your username}.github.io/{repo name}. To use a custom domain name, create a file CNAME in the dist directory containing your domain name.

Edit Data

To make this project your own, simply edit cv.json to reflect the data that would appear on your resume/CV. Changes will be reflected in the web app upon save. Please be sure to remove all information connected to me before hosting publicly.

License

MIT © Sam Lehman