Skip to content

Commit

Permalink
résumé -> resume
Browse files Browse the repository at this point in the history
  • Loading branch information
justin-hackin committed Feb 13, 2023
1 parent 3033d87 commit 4187b9e
Show file tree
Hide file tree
Showing 9 changed files with 22 additions and 22 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Uses custom Vanilla Extract styles and components based on an early version of the Strum Design System
- Non-PDF styles now support dark mode
- Defaults to a Markdown integration as the CMS
- Files in the project pull data for the résumé
- Requires a code change to edit the résumé
- Files in the project pull data for the resume
- Requires a code change to edit the resume
- Uses [OG Impact](https://ogimpact.sh/) to dynamically generate OG share images

### Removed
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Next.js and Tailwind Résumé
# Next.js and Tailwind Resume

A résumé built especially with software professionals in mind. Impress your potential employer with a beautiful and incredibly fast résumé website, or generate a PDF for email and print.
A resume built especially with software professionals in mind. Impress your potential employer with a beautiful and incredibly fast resume website, or generate a PDF for email and print.

[See an example](https://nextjs-resume-generator.vercel.app/)

Your résumé can also generate a secure URL that will display information not accessible on the public URL. The secure version can include private information such as email, phone number, and mailing address. You can send the private link to a potential employer or use it to generate a more complete PDF for yourself.
Your resume can also generate a secure URL that will display information not accessible on the public URL. The secure version can include private information such as email, phone number, and mailing address. You can send the private link to a potential employer or use it to generate a more complete PDF for yourself.

## Features

- Update your résumé with simple Markdown files
- Update your resume with simple Markdown files
- Integration with external headless CMS systems is possible by integrating a custom fetcher
- Beautiful and accessible web app to view your résumé, link on social media, and send to potential employers
- Beautiful and accessible web app to view your resume, link on social media, and send to potential employers
- Generate a PDF on demand to view, download, or print
- Use a secret link to generate the résumé with additional private information
- Use a secret link to generate the resume with additional private information
- Easily customizable
- 19 accent color palettes out-of-the-box
- 6 neutral color palettes out-of-the-box
Expand All @@ -37,7 +37,7 @@ Your résumé can also generate a secure URL that will display information not a

### It's FAST

Your résumé will use the latest Vercel technology including Next.js 13 server components and edge functions, and will load fast even on older devices and poor network conditions.
Your resume will use the latest Vercel technology including Next.js 13 server components and edge functions, and will load fast even on older devices and poor network conditions.

## How To Use This Project

Expand All @@ -61,7 +61,7 @@ Clone the project you just created to your local machine. Open it in your favori

### Color Palette Examples

The résumé generator provides 19 accent color palettes and 6 neutral color palettes out-of-the-box. Below are screenshots from a few variations in both light and dark mode.
The resume generator provides 19 accent color palettes and 6 neutral color palettes out-of-the-box. Below are screenshots from a few variations in both light and dark mode.

| Light Mode | Dark Mode |
| ----------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
Expand All @@ -87,11 +87,11 @@ Although the mock files should be pretty self-explanatory, you can view the [CMS

Regardless of where the app is deployed, it may need access to the following environment variables:

- `PRIVATE_KEY` (optional): this is a code, determined by the author, which will provide URL access to a version of the résumé that includes private information. We recommend generating this code (e.g. a UUID or using a password generator)
- `PRIVATE_KEY` (optional): this is a code, determined by the author, which will provide URL access to a version of the resume that includes private information. We recommend generating this code (e.g. a UUID or using a password generator)

## Private Link

Your project can be configured to provide a secret URL that will display more information than the public URL. This is helpful if you want to send a complete résumé to a potential employer, or if you want to generate a PDF for your own use. In this version, you can include personal information such as email, phone number, and address that you don't want visible to the general public.
Your project can be configured to provide a secret URL that will display more information than the public URL. This is helpful if you want to send a complete resume to a potential employer, or if you want to generate a PDF for your own use. In this version, you can include personal information such as email, phone number, and address that you don't want visible to the general public.

### Setup

Expand All @@ -101,7 +101,7 @@ The private URL will only work if you added a `PRIVATE_KEY` environment variable
PRIVATE_KEY=your-private-key
```

You can then visit `https://your-url.com/private/your-private-key` to see the private version of the résumé.
You can then visit `https://your-url.com/private/your-private-key` to see the private version of the resume.

### Adding Private Content

Expand Down
2 changes: 1 addition & 1 deletion public/manifest.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "Some Body's Professional Résumé",
"name": "Some Body's Professional Resume",
"short_name": "Some Body",
"icons": [
{
Expand Down
2 changes: 1 addition & 1 deletion src/app/DefaultTags.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ const DefaultTags: React.FC = async () => {
content={accents[resumeConfig.accentColor].light[10]}
/>

<meta property="og:site_name" content="Professional Résumé" />
<meta property="og:site_name" content="Professional Resume" />
<meta property="og:url" content={baseURL} />
<meta property="og:type" content="website" />
<meta property="og:image" content={ogImage} />
Expand Down
4 changes: 2 additions & 2 deletions src/app/head.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ import DefaultTags from './DefaultTags';
const Head = async () => {
const data = await getCMSIntegration();
const fullName = getFullName(data.personalInformation);
const title = `Résumé | ${fullName} | ${data.personalInformation.attributes.location}`;
const description = `Professional résumé for ${fullName}.`;
const title = `Resume | ${fullName} | ${data.personalInformation.attributes.location}`;
const description = `Professional resume for ${fullName}.`;

return (
<>
Expand Down
2 changes: 1 addition & 1 deletion src/app/private/[secret]/error.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export default function Error() {
</Heading>

<div className="mt-4">
<Link href="/">Visit public résumé</Link>
<Link href="/">Visit public resume</Link>
</div>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion src/components/Footer/Footer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export const Footer: React.FC<FooterProps> = ({
</div>

<div className="mt-1 text-sm">
This résumé was generated with{' '}
This resume was generated with{' '}
<a className="link" href="https://nextjs.org/">
Next.js
</a>{' '}
Expand Down
4 changes: 2 additions & 2 deletions src/components/Footer/__snapshots__/Footer.test.tsx.snap
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ exports[`<Footer /> Snapshot with links 1`] = `
<div
class="mt-1 text-sm"
>
This résumé was generated with
This resume was generated with
<a
class="link"
Expand Down Expand Up @@ -358,7 +358,7 @@ exports[`<Footer /> Snapshot without links 1`] = `
<div
class="mt-1 text-sm"
>
This résumé was generated with
This resume was generated with
<a
class="link"
Expand Down
2 changes: 1 addition & 1 deletion src/pages/api/og.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ const handler = async (req: NextRequest) => {
}}
tw="text-6xl"
>
Professional Résumé
Professional Resume
</div>
<div style={{ color: accent[12] }} tw="mt-12 text-4xl rounded-lg">
Available online or as a PDF
Expand Down

0 comments on commit 4187b9e

Please sign in to comment.