https://github.com/preethi-dev/supafast-resume-builder
https://github.com/preethi-dev/supafast-resume-builder
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/preethi-dev/supafast-resume-builder
- Owner: Preethi-Dev
- Created: 2024-08-06T02:28:50.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-08-07T19:59:07.000Z (10 months ago)
- Last Synced: 2025-01-08T22:54:22.297Z (4 months ago)
- Language: Svelte
- Homepage: https://supafast-resume-builder.vercel.app
- Size: 1.25 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Supafast⚡ Resume Builder
A modern resume builder application developed using Svelte and SvelteKit. This tool allows users to create and customize their resumes with ease, leveraging GitHub for data retrieval, providing a seamless editing experience, and offering downloadable results.
## Features
- **User ID**: Provide a unique user ID to start building your resume.
- **Template Selection**: Choose from a variety of loved templates to design your resume.
- **GitHub Integration**: Generate a resume based on your GitHub profile data.
- **Custom Editor**: Edit and customize your resume according to your preferences.
- **Preview & Download**: Preview your resume and make changes before downloading the final version.
## Getting Started
### Prerequisites
- Node.js (LTS version recommended)
- npm or yarn
### Installation
1. Clone the repository:
```bash
git clone https://github.com/yourusername/resume-builder.git
cd resume-builder
```
2. Install dependencies:
```
npm install
```
or
```
yarn install
```
## Configuration
User ID: Ensure you provide a unique user ID to save and manage your resume.
Templates: Select your preferred resume template from the available options.
## Usage
Start the development server:
```
npm run dev
```
or
```
yarn dev
```
Open your browser and navigate to http://localhost:5173 to access the application.
## Contributing
If you would like to contribute to the development of this project, please follow these steps:
👩🏽💻Fork the repository.
1. Create a new branch (git checkout -b feature-branch).
2. Commit your changes (git commit -am 'Add new feature').
3. Push to the branch (git push origin feature-branch).
4. Open a pull request.
License
This project is licensed under the MIT License.
Contact
For any questions or feedback, please reach out to [selvampreethi360@gmailcom](#)
Feel free to adjust the details such as the GitHub repository link, your contact information, or any additional instructions specific to your project.
Happy resume building! 🎉