Skip to content

Commit

Permalink
Merge pull request #33 from blopa/feature/add-new-template
Browse files Browse the repository at this point in the history
create new template files
  • Loading branch information
blopa authored May 9, 2021
2 parents 15f3be3 + c4e6574 commit e08d4a1
Show file tree
Hide file tree
Showing 69 changed files with 2,701 additions and 275 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 blopa
Copyright (c) 2021 blopa

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
33 changes: 26 additions & 7 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,11 @@ Older versions: [V1](https://github.com/blopa/Resume-Builder/blob/main/README_V1
- Cover Letter Editor

## JSON Resume Schema
This project uses the [jsonresume/resume-schema](https://github.com/jsonresume/resume-schema) v1.0.0, but due a need to extend some of it's features, we also added 2 new fields: `__translation__` to translate template keys, and `coverLetter` so you can add your own Cover Letter template.
This project uses the [jsonresume/resume-schema](https://github.com/jsonresume/resume-schema) v1.0.0, but due a need to extend some of it's features, we also added 4 new fields:
- `__translation__` to translate template keys.
- `coverLetter` to add your own Cover Letter template.
- `work[].keywords` to add keywords to your work experience.
- `enableSourceDataDownload` to allow the JSON data to be downloaded from the resume itself.

## Online viewer
Create a GitHub repo [like this one](https://github.com/blopa/resume.json) with the name `resume.json` and a file called `resume.json` in a branch called `main` and following the JSON schema from [github.com/jsonresume/resume-schema](https://github.com/jsonresume/resume-schema/tree/v1.0.0) v1.0.0.
Expand Down Expand Up @@ -146,6 +150,10 @@ The following `JSON` is a result of [this Google Spreadsheet](https://docs.googl
"Build an algorithm for artist to detect if their music was violating copy right infringement laws",
"Successfully won Techcrunch Disrupt",
"Optimized an algorithm that holds the current world record for Weisman Scores"
],
"keywords": [
"Javascript",
"React"
]
}
],
Expand Down Expand Up @@ -267,11 +275,6 @@ The following `JSON` is a result of [this Google Spreadsheet](https://docs.googl
"type": "application"
}
],
"meta": {
"canonical": "https://raw.githubusercontent.com/jsonresume/resume-schema/master/resume.json",
"version": "v1.0.0",
"lastModified": "2017-12-24T15:53:00"
},
"__translation__": {
"awards": "Prizes",
"volunteers": "Volunteers",
Expand All @@ -284,7 +287,8 @@ The following `JSON` is a result of [this Google Spreadsheet](https://docs.googl
"summary": "Summary",
"experience": "Experience",
"at": "at"
}
},
"enableSourceDataDownload": true
}
```

Expand All @@ -299,6 +303,13 @@ The following `JSON` is a result of [this Google Spreadsheet](https://docs.googl
![ScreenShot](https://raw.githubusercontent.com/blopa/Resume-Builder/main/screenshots/v4/screenshot_3.png)

## Release Notes
- **v4.0.2:**
- Filter out resume templates that are not ready yet.
- Add download link to download the JSON data.
- Fix resume viewer.
- Add missing fields on "work" and "projects".
- Small layout fixes in the "Default" template.
- Arrays from the spreadsheet are now parsed using `';'` instead of `','`.
- **v4.0.1:**
- Add visual cue to the cover letter variables.
- **v4.0.0:**
Expand All @@ -307,6 +318,8 @@ The following `JSON` is a result of [this Google Spreadsheet](https://docs.googl
- Update JSON Schema to v1.0.0.
- Update Gatsby to v3.

[Complete Release Notes here](https://github.com/blopa/Resume-Builder/blob/main/release-notes.md)

## Thanks to
- SEO resume photo by [Markus Winkler](https://unsplash.com/@markuswinkler?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText) on [Unsplash](https://unsplash.com/s/photos/resume?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText).

Expand All @@ -320,6 +333,12 @@ A: I can try. Open an issue, and I'll see what I can do.
A: Thank you! You can help by codding more features, creating pull requests, or donating via [https://bunq.me/BuyMeASoda](https://bunq.me/BuyMeASoda)

## TODO
- Fix all TODOs in the code
- Add proptypes to the components
- Add documentation on how to create new templates
- Add form to manually add resume data
- Add support for Redux Tools extension
- Use https://github.com/MrRio/jsPDF
- Load a JSON resume from any URL
- Actually create a second template
- Add unit tests
Expand Down
2 changes: 2 additions & 0 deletions README_V1.MD
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,8 @@ The following ``JSON`` is a result of [this Google Spreadsheet](https://docs.goo
- **v0.0.1:**
- First working version

[Complete Release Notes here](https://github.com/blopa/Resume-Builder/blob/main/release-notes.md)

## F.A.Q.
**Q: Can you implement <???> function?**

Expand Down
4 changes: 3 additions & 1 deletion README_V2.MD
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ The following ``JSON`` is a result of [this Google Spreadsheet](https://docs.goo
![ScreenShot](https://raw.githubusercontent.com/blopa/Resume-Builder/main/screenshots/v2/screenshot_3.png)

## Release Notes
- **v2.0.3:** (not tagged yet)
- **v2.0.3:** (not tagged)
- ~~Fix CORS problem when loading a spreadsheet from URL.~~ (still trying to figure this one out)
- Update packages.
- Add new ESlint rules.
Expand All @@ -176,6 +176,8 @@ The following ``JSON`` is a result of [this Google Spreadsheet](https://docs.goo
- **v2.0.0:**
- Everything rebuild from scratch.

[Complete Release Notes here](https://github.com/blopa/Resume-Builder/blob/main/release-notes.md)

## F.A.Q.
**Q: Can you implement <???> function?**

Expand Down
4 changes: 3 additions & 1 deletion README_V3.MD
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<img src="/screenshots/v3/resume_builder.gif?raw=true" width="890px">

## About
[Resume Builder](https://blopa.github.io/Legacy-Resume-Builder/v3) is a free open-source project that allows anyone to easily maintain and build any kind of resume using Google Spreadsheets. This was develop as a personal project to help a friend who was struggling spending up to an hour to make a custom resumes. **[TRY IT NOW](https://blopa.github.io/Legacy-Resume-Builder/v3).**
[Resume Builder](https://blopa.github.io/Legacy-Resume-Builder/v3/en) is a free open-source project that allows anyone to easily maintain and build any kind of resume using Google Spreadsheets. This was develop as a personal project to help a friend who was struggling spending up to an hour to make a custom resumes. **[TRY IT NOW](https://blopa.github.io/Legacy-Resume-Builder/v3/en).**

For the latest version, access [https://resume-builder.js.org](https://resume-builder.js.org).

Expand Down Expand Up @@ -227,6 +227,8 @@ The following ``JSON`` is a result of [this Google Spreadsheet](https://docs.goo
- **v3.0.0:**
- Rebuild using Gatsby.

[Complete Release Notes here](https://github.com/blopa/Resume-Builder/blob/main/release-notes.md)

## Thanks to
- SEO resume photo by [Markus Winkler](https://unsplash.com/@markuswinkler?utm_source=unsplash&amp;utm_medium=referral&amp;utm_content=creditCopyText) on [Unsplash](https://unsplash.com/s/photos/resume?utm_source=unsplash&amp;utm_medium=referral&amp;utm_content=creditCopyText).

Expand Down
45 changes: 28 additions & 17 deletions gatsby-node.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ const { promises: fs } = require('fs');
const packageJson = require('./package.json');

const TEMPLATES_PATH = path.resolve(__dirname, 'src/components/ResumeTemplates');
const disabledTemplates = ['Compact', 'VanHack'];
const ignoredPages = ['/Home/'];
const {
convertToKebabCase,
Expand Down Expand Up @@ -44,24 +45,26 @@ exports.onCreatePage = async ({ page, actions }) => {

if (page.context.intl.originalPath === '/ResumeViewer/') {
const templates = await fs.readdir(TEMPLATES_PATH);
templates.forEach((template) => {
if (
page.internalComponentName === 'ComponentResumeViewer'

templates.filter((template) => !disabledTemplates.includes(template))
.forEach((template) => {
if (
page.internalComponentName === 'ComponentResumeViewer'
&& language !== 'en'
) {
return;
}
) {
return;
}

pagePath = `/view/${template}`.toLocaleLowerCase();
matchPath = `${pagePath}/*`;
myCreatePage(
createPage,
page,
pagePath,
matchPath,
language
);
});
pagePath = `/view/${template}`.toLocaleLowerCase();
matchPath = `${pagePath}/*`;
myCreatePage(
createPage,
page,
pagePath,
matchPath,
language
);
});

return;
}
Expand All @@ -80,10 +83,18 @@ exports.onCreateWebpackConfig = async ({
actions,
}) => {
const templates = await fs.readdir(TEMPLATES_PATH);

// TODO this fixes the 'React Refresh Babel' error where NODE_ENV is 'local' for some reason
if (process.env.NODE_ENV !== 'production') {
process.env.NODE_ENV = 'development';
}

actions.setWebpackConfig({
plugins: [
plugins.define({
TEMPLATES_LIST: JSON.stringify(templates),
TEMPLATES_LIST: JSON.stringify(
templates.filter((template) => !disabledTemplates.includes(template))
),
VERSION: JSON.stringify(packageJson.version),
}),
],
Expand Down
Loading

0 comments on commit e08d4a1

Please sign in to comment.