ATS | Docs

Create Your ATS Resume & Cover Letter

Follow these detailed steps to set up and customize your resume and cover letter for Applicant Tracking Systems.

Getting Started

Visit the GitHub Repository

Navigate to the project's GitHub page to access the source code and further instructions.

Clone the Project Repository

Open your terminal or command prompt and clone the repository to your local development environment using the `git clone` command followed by the repository URL.

git clone https://github.com/egarrisxn/resume-builder.git

Install Project Dependencies

Navigate into the cloned project directory in your terminal and install the necessary dependencies using either `npm` or `yarn`.

npm install

yarn install

Start Local Development Server

Start the local development server to preview and work on your resume and cover letter. This usually involves running a command provided by the project.

npm run dev

yarn dev

Locate Template Files

Find the template files for your resume and cover letter within the public directory of the project.

public/resume

public/cover-letter

Update Your Personal Data

Open the resume and/or cover-letter files and replace the placeholder content with your own information, including your work experience, education, skills, and contact details.

Pay close attention to the formatting and structure of the templates to ensure they are ATS-friendly.

Locate API Endpoint Functions

Find the API endpoint functions responsible for generating the resume and cover letter. These are typically located in the api directory.

api/generate-resume

api/generate-cover-letter

Update the Header Keyword Function

Within the API endpoint files, locate and update the headerKeyword function (or similar) to include relevant keywords that align with the job descriptions you are targeting. This helps your resume and cover letter get noticed by ATS.

Refer to the comments or documentation within the code for specific instructions on how to modify this function.

Navigate to the Generate Page

Once you have updated your data and the header keywords, navigate to the Generate page of the application in your web browser.

Preview Your Files

On the Generate page, you should be able to see a rendered version of your resume and cover letter. Carefully review both documents to ensure all your information is displayed correctly and the formatting looks as expected.

Revise if Necessary

If you notice any errors, missing information, or formatting issues during the preview, go back to the public/resume and public/cover-letter files and make the necessary revisions. Repeat steps 7-10 until you are satisfied with the result.

Your Perfect Documents!

Once you are completely satisfied with the preview of your resume and cover letter, you can proceed to save or download them from the Generate page. Congratulations, you now have ATS-friendly documents ready for your job applications!

Need tips? Visit Tips to perfect your resume!

Ready to preview? Go to Generate for your resume!

Navigating Resbuilder

You can navigate through the application using the navigation bar at the top of the page. Key sections include:

Home - The main landing page providing an overview of Resbuilder.

Examples - Showcases different ways resumes can be generated using various formats.

Tips - Offers valuable advice and insights on crafting effective resumes and cover letters.

Docs - You are currently here! This page provides detailed information on using the application.

Understanding the Generation Methods

Explore Different Formats

Resbuilder showcases various methods for generating resumes and cover letters, demonstrating the flexibility of modern web development. You can explore examples rendered from different formats:

API route (client)API route (server)JSON file (local)Markdown file (client)Markdown file (server)MDX file (server) MDX file (static)Text file (static)

These examples illustrate different data sources and rendering techniques. The core functionality will allow you to input your information through a user interface (coming soon!) to generate your documents.

Previewing Your Documents as PDF

Once your resume or cover letter is generated, you can preview it as a PDF to ensure it looks professional before you save or print. The PDF preview currently expects a pdfUrl parameter. This will be seamlessly integrated with the generation process in future updates.

Go to PDF Preview

Future Enhancements

Resbuilder is actively being developed. Here are some of the exciting features planned:

- Intuitive user interface for direct resume and cover letter input.

- Customizable resume templates.

- Support for DOC and DOCX export formats.

- Advanced ATS optimization tips integrated into the creation process.