candyapplecorn / interactive-resume

An open source interactive resume application that will allow users to upload a plaintext resume and convert it to a static interactive resume app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Interactive Resume

Today:

  • A collection of Markdown JSX files (mdx) go in, and a static website bundle comes out.

WIP / "Tomorrow":

  • A collection of Markdown JSX files (mdx) go in, and a static website bundle ✨ powered by content-aware conversational artificial intelligence ✨ comes out.

How does it work?

The Markdown JSX files support a novel sub-page format like so:

entrypoint.mdx

# Welcome to my page!

I like <FlowersLink />!

flowers.mdx

# Flowers

I sure do like flowers. My favorites are roses and tulips :)

The <FlowersLink /> JSX element will automatically be generated by the "framework"; it goes by filename and appends Link. The <FlowersLink /> appears as flowers and when clicked causes the webpage to navigate to a sub-page using React Router

Wiki

There's a wiki! Additionally, Joe is cataloguing additional AI research material here.

Here's a cool page from the wiki showing the control flow diagram for updating the knowledge base for the large language model, as well as keeping parity with existing documents across the vector database and storage solution.

Packages

  • Vite - https://vitejs.dev/ - An alternative to webpack; provides a development environment with hot module reloading, and bundles all html/javascript/css/assets into a static web bundle.
  • MDX - https://mdxjs.com/ - A cool abstraction that wraps markdown with JSX component support.
  • React, React Router

Work in Progress

We are working on integrating large language model support for the documents, so that a user of the client may ask the document questions about itself. For more information, see:

Authors

Develoepr Notes

Joseph's gone and forked this repo. In order to push commits to a fork, he's found this as the most convenient method.
Assuming two remotes,
A: git@github.com:austinrafter/interactive-resume.git
B: git@github.com:candyapplecorn/interactive-resume.git

  1. Push the commits up to the current remote A.
  2. Change the current remote to B:
    git remote set-url origin git@github.com:candyapplecorn/interactive-resume.git
  3. Merge the previous remote's code into local:
    git merge origin git@github.com:austinrafter/interactive-resume.git main
    (not 100% sure this command is right)
  4. Push the local up to remote B

And that's how you can keep a fork up to date with another branch! Don't forget to switch the remote back to the original branch when you're done 😊

List remotes with their URL's: git remote -v

candy/interactive-resume        git@github.com:candyapplecorn/interactive-resume.git (fetch)
candy/interactive-resume        git@github.com:candyapplecorn/interactive-resume.git (push)
origin  git@github.com:austinrafter/interactive-resume.git (fetch)
origin  git@github.com:austinrafter/interactive-resume.git (push)

This is handy because it shows which remote is currently set as the default remote.

About

An open source interactive resume application that will allow users to upload a plaintext resume and convert it to a static interactive resume app


Languages

Language:TypeScript 77.9%Language:Less 12.1%Language:CSS 5.1%Language:JavaScript 3.1%Language:HTML 1.6%Language:Shell 0.3%