- π Table of Contents
- π Overview - ResumeGenius provides an AI-driven resume builder, enabling users to create professional resumes quickly. The platform is designed to help users stand out with customizable templates and efficient formatting tools.
- πΎ Features
- π Project Structure
- π Getting Started
- π° Contributing
- π License
- π Acknowledgments
ResumeGenius provides an AI-driven resume builder, enabling users to create professional resumes quickly. The platform is designed to help users stand out with customizable templates and efficient formatting tools.
βββ ai-resume-builder/
βββ README.md
βββ Resume.docx
βββ bun.lockb
βββ components
β βββ Footer.jsx
β βββ Navigationbar.js
β βββ resumes
βββ data
β βββ templates.js
βββ jsconfig.json
βββ next.config.js
βββ package.json
βββ pages
β βββ _app.js
β βββ _document.js
β βββ api
β βββ auth
β βββ create.jsx
β βββ index.js
β βββ profile.js
βββ postcss.config.js
βββ public
β βββ document-application-icon.png
β βββ donate.webp
β βββ external-link-icon.png
β βββ family-icon.png
β βββ favicon.ico
β βββ file-black-icon.png
β βββ folder-icon.png
β βββ next.svg
β βββ person.jpg
β βββ resume
β βββ ui.png
β βββ vercel.svg
βββ resumes
β βββ basic.html
β βββ basic.png
β βββ modern.html
β βββ modern.png
β βββ nextlevel.html
β βββ nextlevel.png
β βββ person.jpg
β βββ professional.html
β βββ professional.png
βββ styles
β βββ globals.css
βββ tailwind.config.js
βββ test
β βββ resume.pdf
β βββ resume2.pdf
βββ ui
β βββ Cover Letter Generator.png
β βββ Landing.png
β βββ Resume Creator.png
β βββ Success.png
βββ utils
βββ appwrite.js
βββ auth.js
βββ create_pdf.js
βββ dateFormat.js
βββ fetchSummary.js
βββ resumeTemplates.js
βββ uplode.jsAI-RESUME-BUILDER/
__root__
postcss.config.js β― REPLACE-MEtailwind.config.js β― REPLACE-MEjsconfig.json β― REPLACE-MEnext.config.js β― REPLACE-MEpackage.json β― REPLACE-ME
styles
globals.css β― REPLACE-ME
components
Navigationbar.js β― REPLACE-MEFooter.jsx β― REPLACE-MEresumes
pro.js β― REPLACE-MEnextlevel.js β― REPLACE-MEmodern.js β― REPLACE-MEbasic.js β― REPLACE-ME
pages
_document.js β― REPLACE-MEprofile.js β― REPLACE-ME_app.js β― REPLACE-MEindex.js β― REPLACE-MEcreate.jsx β― REPLACE-MEapi
generate-content.js β― REPLACE-ME
utils
resumeTemplates.js β― REPLACE-MEfetchSummary.js β― REPLACE-MEappwrite.js β― REPLACE-MEuplode.js β― REPLACE-MEcreate_pdf.js β― REPLACE-MEdateFormat.js β― REPLACE-MEauth.js β― REPLACE-ME
resumes
nextlevel.html β― REPLACE-MEprofessional.html β― REPLACE-MEmodern.html β― REPLACE-MEbasic.html β― REPLACE-ME
Before getting started with ai-resume-builder, ensure your runtime environment meets the following requirements:
- Programming Language: JavaScript
- Package Manager: Npm
Install ai-resume-builder using one of the following methods:
Build from source:
- Clone the ai-resume-builder repository:
β― git clone https://github.com/000xs/ai-resume-builder- Navigate to the project directory:
β― cd ai-resume-builder- Install the project dependencies:
β― npm installRun ai-resume-builder using the following command:
Using npm Β
β― npm startRun the test suite using the following command:
Using npm Β
β― npm test- π¬ Join the Discussions: Share your insights, provide feedback, or ask questions.
- π Report Issues: Submit bugs found or log feature requests for the
ai-resume-builderproject. - π‘ Submit Pull Requests: Review open PRs, and submit your own PRs.
Contributing Guidelines
- Fork the Repository: Start by forking the project repository to your github account.
- Clone Locally: Clone the forked repository to your local machine using a git client.
git clone https://github.com/000xs/ai-resume-builder
- Create a New Branch: Always work on a new branch, giving it a descriptive name.
git checkout -b new-feature-x
- Make Your Changes: Develop and test your changes locally.
- Commit Your Changes: Commit with a clear message describing your updates.
git commit -m 'Implemented new feature x.' - Push to github: Push the changes to your forked repository.
git push origin new-feature-x
- Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
- Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
This project is protected under the MIT License. For more details, refer to the LICENSE file.
- List any resources, contributors, inspiration, etc. here.