CVCraft is a React-based web application that helps users create and manage their CVs with ease. It's built with simplicity in mind, allowing you to input your skills and work experience and see them reflected on your CV immediately.
- Input sections for skills and work experience
- Centralized state management for enhanced state handling across components
- Responsive design for mobile and desktop usability
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Before you begin, ensure you have met the following requirements:
- You have installed the latest version of Node.js and npm.
Follow these steps to get your development environment running:
-
Clone the repository to your local machine:
git clone https://github.com/CallMeMaverick/CVCraft.git
-
Navigate to the cloned repo:
cd CVCraft -
Install project's dependencies:
npm install
-
Start the development server:
npm run dev
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Before You Contribute:
Review the coding style: Familiarize yourself with coding conventions to ensure consistency.
Fork the repository: Create a personal fork of the repository to work on your changes.
Open an issue: For major changes, discuss your ideas in an issue before starting a pull request.
Write clear commit messages: Use descriptive commit messages that explain your changes.
Test your changes: Ensure your contributions don't break existing functionality. Write or update tests as needed.
This project is licensed under the Apache-2.0 License - see the LICENSE.md file for details