DevBuild Resume Documentation

Learn how to use DevBuild Resume to create your perfect developer resume.

Template (template.json)|Example (example.json)

Getting Started

Prerequisites

  • A GitHub account (for hosting your resume data).
  • Basic understanding of JSON data structure.
  • A web browser.

Understanding `template.json` and `example.json`

To help you get started, this application provides two important JSON files:

  • `template.json`: This file, located in the /public/data/ directory, outlines the **required structure** for your `resume.json` file. It shows you the expected fields (like `personalInfo`, `experience`, `education`, `skills`, etc.) and their basic organization. Use this as a blueprint for creating your own resume data.
  • `example.json`: Also found in /public/data/, this file provides **sample data** that conforms to the `template.json` structure. It includes example entries for each section, giving you a clearer idea of how to format your own information. Feel free to refer to this while building your `resume.json`.
Remember to create your own `resume.json` file in your separate GitHub repository based on the structure defined in `template.json` and populated with your own information, potentially referencing the examples in `example.json`.

Setting Up Your Resume Data

  1. Create a GitHub Repository: Go to GitHub and create a new public repository to store your resume data.
  2. Create Data Structure: Inside your new repository, create:
    • A folder named images for your avatar and other images.
    • A file named resume.json which will contain your resume content.
  3. Reference the Template: In this application"s directory, navigate to /public/data/ and open template.json. This file provides the expected structure for your resume.json file.
  4. Populate Your `resume.json`: Create your own resume.json file in your GitHub repository based on the template.json structure. Fill in your personal details, experience, education, skills, etc.
  5. Add Your Avatar (Optional): Place your avatar image inside the images folder in your GitHub repository. Ensure the path in your resume.json correctly points to this image (e.g., `"avatar": "https://your-github-username.github.io/your-repo-name/images/avatar.png"`).

Deploying Your Data with GitHub Pages

  1. Enable GitHub Pages: In your GitHub repository, navigate to "Settings" > "Pages".
  2. Source Selection: Under "Build and deployment", select "Deploy from a branch". Choose your main branch (usually `main` or `master`) and save.
  3. Your GitHub Pages URL: Once deployed, you'll find your site URL under the "GitHub Pages" section. It will typically be in the format: https://<your-github-username>.github.io/<your-repo-name>/.

Updating the Data Endpoint

  1. Locate `resumeAPI.ts`: In this application's source code, find the file located at src/libs/resumeAPI.ts (or a similar file where API calls are handled).
  2. Update the `fetchResumeData` Function: Modify the URL in the `fetch` request to point to the URL of your deployed GitHub Pages site, specifically the resume.json file. For example:
    const fetchResumeData = async () => { const response = await fetch('https:// <your-github-username> .github.io / <your-repo-name> / resume.json'); // ... rest of the code };
  3. Save Changes: Save the updated file. The application should now fetch your resume data from your GitHub Pages URL.

Local Development Note

During local development, the application might be configured to use the example.json file in the /public/data/ directory for convenience. However, for the production build and to ensure your custom data is used, you must configure the API endpoint to your GitHub Pages URL.

ATS Compatibility Considerations

While **DevBuild Resume** offers a visually appealing layout, some advanced styling and formatting might not be parsed correctly by all Applicant Tracking Systems (ATS). If ATS compatibility is a primary concern, consider the following:
  • Using standard, common fonts.
  • Minimizing the use of complex layouts (e.g., multi-column).
  • Simplifying section headings and formatting.
  • Generating a plain text or basic PDF version of your resume specifically for ATS submissions.