Skip to content

Repository files navigation

QuikRes

License: MIT GitHub repo size GitHub last commit

quikres

🚀 What is QuikRes?

QuikRes lets you turn your resume into a beautiful, personal website, in under a minute. No paywalls. No ads. Just fast & free!

Note: This project was inspired by Self.so. Thanks for giving me the vision for QuikRes.

🛠️ Tech Stack

  • Next.js
  • React
  • TypeScript
  • Tailwind CSS
  • TanStack Query
  • AWS S3
  • Upstash Redis
  • Clerk Authentication
  • OpenAI
  • Vercel AI SDK
  • Vercel Deployment
  • More coming soon...

⚙️ Getting Started

  1. Clone the Repo
git clone https://github.com/egarrisxn/quikres.git
cd quikres
  1. Set Up Required Accounts
  • Together.ai - for LLM
  • Upstash - for Redis database
  • AWS - for S3 bucket
  1. Configure Environment Variables
  • Create a .env or .env.local file
  • Add your API keys, secrets, etc
  1. Install Dependencies
pnpm install
  1. Run the App Locally
pnpm dev

🚦 Usage

  1. Create an Account
  • Sign up on the site using Clerk authentication.
  1. Upload Your Resume (PDF)
  • Upload your resume through the dashboard.
  • It’s securely uploaded to an AWS S3 BUCKET.
  1. AI Processing
  • Your resume is sent out for a quick processing via Together.ai.
  • The model extracts structured data (e.g. work experience, skills, education) in JSON format.
  1. Instant Website Generation
  • A personalized, responsive website is generated from your resume content.
  • View, customize, and publish your site instantly with a unique dynamic route.

🚀 Deploying

The easiest way to deploy QuikRes is with Vercel, the creators of Next.js. Smash the button below to begin.

Deploy with Vercel

📄 License

This project is licensed under the MIT License.

📬 Contact

Have questions, feedback, or want to collaborate?

About

Resume to website in less than a minute! 100% free and easy to use. Technologies: Next.js, React, TypeScript, Tanstack Query, Upstash Redis, AWS, Clerk, OpenAI, Tailwind CSS, Vercel, & more.

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages