A simple web app that automates the process of creating custom resume versions for different jobs using the job description.
System Requirements:
- Node.js 18.17 or later.
- macOS, Windows (including WSL), and Linux are supported.
- Fork the repository and clone the repository into your local machine
- You can now run this project locally by using the following commands🎉
npm install
npm run dev- Open http://localhost:3000 with your browser to see the result.
You can run the tests once by using the command npm run test
You can also run the tests in watch mode by using the following command npm run test:watch
-
If you see an issue that you want to work on, please comment on that issue and once you have the confirmation from one of the maintainers, you can stat working on that issue. OR
-
You can also create a new issue that you think should be worked on. Once that issue gets accepted by any of the maintainers of the project, then you can start working on that issue.
-
Once you have an issue to work on, fork and clone the repository
-
Create a branch and make the changes in your branch
-
Push the changes and create a pull request for it.
-
Make sure that you enter all the required information in the pull-request template
-
Once your pull-request passes all the checks and have the required approvals, then your pull request can be merged with master.
-
Make sure that existing tests pass after your changes.
Here's a good short video describing this process
npm run dev
- prod: The production branch
- master: This is the default and root branch of our project.
- Feature: Feature branches where all the changes are made. The PRs are made against the master branch from these feature branches. You should have good, short and descriptive names for your feature branches.
If you found this project useful, then please consider giving it a ⭐ on Github and sharing it with your friends via social media. It really motivate us to do more.