\n\n \n\n# react-ultimate-resume by WeLoveDevs.com\n[](https://www.npmjs.com/package/@welovedevs/react-ultimate-resume)\n[](https://www.npmjs.com/package/@welovedevs/react-ultimate-resume)\n\n**react-ultimate-resume** is an open-source customizable software developer resume to highlight your skills and experiences.\n\nDiscover a modern approach of the traditional CV that includes animations and latest front-end technologies. Impress recruiters or customers with your projects, hobbies and experiences as never before.\n\nWe used [JSON Resume](https://github.com/jsonresume), a community driven open source initiative to create a JSON based standard for resumes.\nDiscover the official schema [here](https://jsonresume.org/schema/).\nWe added a few extra-fields to JSON Resume standard to fit developers needs. Learn more about them [here](#json-resume-extra-fields).\n\nThis app is built using the popular [create-react-app](https://github.com/facebook/create-react-app). You will find a lot of resources to understand how to edit and publish your resume directly on https://create-react-app.dev/\n\n\n### Preview\n\n[](https://vincent-cotro.welovedevs.com)\n\n[Demo profile here](https://vincent-cotro.welovedevs.com/)\n\n### Docs\n\nDocs can be found [Here](https://welovedevs.com/react-ultimate-resume/docs/home). \n\nFeel free to improve it with a PR β₯οΈ\n\n### Features\n\nThe resume is designed with 10 Cards (we plan to add more !)\n- π Basics: Your basics : Where are you ? When did you start coding ...\n- π Skills: Beautiful Graphs to show your skills\n- πΌ Dream job: Explain easily to recruiters what is your dream job\n- πΎ Experiences: Describe your professional experiences\n- π Studies: How did you learn to code ?\n- β¨ Projects: Highlight your best projects\n- πΊ Hobbies: Show your hobbies with GIF !\n- πΆ Music: Add your favorite Spotify Playlist\n- π Interested by: Tell more about technologies you would love to learn\n- π Languages: What language do you master?\n\nEach cards comes with an edit dialog to edit your JSON Resume directly inside the app\n\n\n### Customize your Profile\n\nπ¨ This resume is fully customizable with an included set of nice color palettes :\n\n\n\n\n### Getting started\n\nFork this repository. `git clone` your fork πͺ\n\nInstall\n\n```\nyarn install\n```\n\nRun\n\n```\nyarn start\n```\n\nSee the website on localhost with the following url:\n```\nlocalhost:3000\n```\n\nReplace the default JSON Resume with yours\n```\n/src/data/json_stub.json\n```\n\n### Deploy on you own server\n\nYou can deploy your resume on your own server in few minutes. Follow our [HOW TO documentation](https://welovedevs.com/react-ultimate-resume/docs/deploy-fork). \n\n### Use inside your project\n\nYou can install the resume directly inside your project.\n\n```\nnpm i @welovedevs/react-ultimate-resume\n```\n\nThen\n\n```\nimport DeveloperProfile from '@welovedevs/react-ultimate-resume';\n```\n\n\n### Parameters\n\n**Parameter**|**Type**|**Description**\n:-----:|:-----:|:-----:\nmode|\"edit\" \\| \"readOnly\"|Use this to activate or disable the Edit mode. In \"edit\" mode you will be able to update and customize your resume. Use \"readOnly\" in production.\ndata|JSONResume|This is your stringified JSONResume\noptions|Object|See options for more informations [here](#options)\nonCustomizationChanged|Callback|Get the current customization if the customization is updated.\nadditionalNodes|Object|Additional nodes is used to add react components directly inside the resume. This is an advanced feature that will be documented later.\n\n\n\n#### Options\n\n**Parameter**|**Type**|**Description**\n:-----:|:-----:|:-----:\nlocale|\"fr\" \\| \"en\"|Resume locale (Default to \"en\")\nside|\"front\" \\| \"back\"|Cards default side (Default to \"front\")\napiKeys|{ giphy : string }|Api keys for 3thd party librairies. For instance Giphy in edit mode.\nendpoint|{ devicons : string, unsplashProxy: string }|Endpoints for 3thd party services. Used to get the technology list and use unsplash.\ncustomization|Object|Current resume customization.\n\n\n### JSON-Resume Extra Fields\n\n**Category**|**Field name**|**Type**|**Description**\n:-----:|:-----:|:-----:|:-----:\nbasics|visaSponsorship|Boolean|True if you need a visa sponsorship to work in your dream country.\nbasics|personalDescription|String|A short description that will be displayed below your name in the resume header. Example: \"Passionate React Developer\".\ndreamJob|locations|Array<{ name : string, title: string }>|Your dream job cities. Example: \"San Francisco, US\".\nwork|remote|String|Give here more information about the frequency if your dream job is a remote job. Example: \"regularly\"\neducation|studiesLevel|Number|What is your highest level of formal education? (Bachelor = 3 years post graduate. Master = 5 years post graduate)\nwork|contractTypes| Array<\"fixedTerm\" \\| \"permanent\" \\| \"internship\" \\| \"apprenticeship\" \\| \"freelance\">|Your dream job contract types. Example: ['fixedTerm']\nwork|codingYears|Number|How long have you been coding (in years)? Example: 5\nwork|codingReason|String|What motivates you to wake up every day to code?\nwork|searchState|\"activelySearching\" \\| \"openOpportunities\" \\| \"dreamjobOnly\" \\| \"notSearching\" |Are you open to new job opportunities?\nwork|experienceYears|Number|How many years of professional experience do you have?\nsound|embedUrl|String|Your favorite Spotify playlist.\ninterestedBy| |String|What languages do you want to learn? Example: Angular and Vue.js\n\n\n### Hosted for free on WeLoveDevs.com\n\nDon't want to host your profile ? \nCreate your JSONResume and get your free subdomain in less than 10 minutes by registering on [welovedevs.com](https://welovedevs.com/app/register_developer).\n\nWe added a few extra features that you will love :\n- β‘ Server side rendering for ultra fast loading\n- π Secured using reCAPTCHA v3, HTTPS and Cloudflare\n\n### i18n\n\nThe resume is currently available in English, French and Turkish. Feel free to contribute with your language translation file ! \n\n### Built by the community π\n\nhttps://web-develop.me/ - by [@liorchalma](https://github.com/liorchamla)\n\n### Contributors\nThis project exists thanks to all the people who contribute.\n
\n\nChat with us on [Discord](https://discord.gg/udbbbAq) !\n\n\n ### License\n\nreact-ultimate-resume is relased under [GNU AGPL v3 license](https://github.com/welovedevs/developer-profile/blob/master/LICENSE.md)\n\n\n\n## About WeLoveDevs.com\nWeLoveDevs.com is a website crafted for developers (by Developers) looking for new career opportunities.\nMore than 1700 companies use WeLoveDevs.com to find their talents.\nDiscover your next company [here](https://welovedevs.com/app/companies)\n","readmeFilename":"README.md"}
![](\"https://cdn.filestackcontent.com/compress/fyFHRMfCRL2xhwCVtx0F\")
\n![\"\"/](\"https://avatars.githubusercontent.com/u/18561703?v=3\")
![\"\"/](\"https://avatars.githubusercontent.com/u/5870982?v=3\")
![\"\"/](\"https://avatars.githubusercontent.com/u/9655206?v=3\")
![\"\"/](\"https://avatars.githubusercontent.com/u/6273310?v=3\")