CVComposer is a web-based platform designed to help job seekers create impressive CVs (Curriculum Vitae) and Cover Letters with ease. This README provides an overview of the MVP (Minimum Viable Product) version of CVComposer, highlighting its features, installation instructions, and usage guidelines.
The CVComposer MVP includes the following key features:
-
CV Creation: Users can create and edit CVs using customizable templates.
-
Content Customization: Users can personalize their CVs and Cover Letters by adding and editing content, including personal information, work experience, education, and more.
-
Design Customization: Users can customize the design of their CVs and Cover Letters by adjusting colors and fonts to match their preferences.
-
Preview and Export: Users can preview their documents in real time and export them as downloadable PDF files.
-
Responsive Design: The platform is responsive and accessible on various devices, including desktops, tablets, and smartphones.
To run the CVComposer MVP locally for development or testing purposes, follow these steps:
-
Clone the repository to your local machine:
git clone https://github.com/MelakuDemeke/CVComposer.git
-
Navigate to the project directory:
cd CVComposer -
Install the required dependencies:
npm install
-
Start the development server:
npm run dev
-
Open your web browser and access the application at
http://localhost:3000.
-
CV Creation:
- You will be great by a landing page
- Click on "Create CV" and you'll be directed to the dashboard.
- Choose a template and begin customizing your document.
-
Customization and Preview:
- Customize the document's content and design.
- Use the "Preview" feature to see real-time updates.
-
Export:
- Once satisfied, click on the "PDF" button to download your CV as a PDF.
This project is licensed under the MIT License. Feel free to modify and distribute the project as per the terms of the license.