Code Monkey home page Code Monkey logo

resume-craft's Introduction

Resume Craft 📃

A simple web app that automates the process of creating custom resume versions for different jobs using the job description.

Next.js Typescript JavaScript React Hook Form

Getting Started

Prerequisites

System Requirements:

  • Node.js 18.17 or later.
  • macOS, Windows (including WSL), and Linux are supported.

Running the repo locally

  • 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

Running the tests

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

Contribution

  • 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

Branches

  • 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.

❤️ Found this project useful?

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.

resume-craft's People

Contributors

amlan-roy avatar avi-l avatar tusharwebd avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.