ResumeWizard

///

How it works

Installation

This project is built on nextJS 13 experimental version

1. Fork the repo into your account

2. Clone the project into your local machine

git clone https://github.com/<Your-name>/ResumeWizard.git

3. Navigate the folder

cd resume-wizard

3. Install the dependencies

npm install

4. Make .env file in root directory with these variables

OPEN_API_KEY= 'YOUR OPENAI API KEY GOES HERE'

• Get your openAi api key here: OPENAI API

5. Run the project on local machine

npm run dev

6. Every time you start making changes to your forked repo make sure it's in sync with the original repo

Contributing Guidelines

Thank you for considering to contribute to this project.

What do I need to know to contribute?

This project is in a very early stage so anybody who's familiar with ReactJS/NextJS/Typescript/TailwindCSS can contribute. If you don't feel ready to make a contribution yet, no problem at all. You can also contribute to this ReadMe section or the Documentation part of our project.

If you are interested to contribute and want to learn more about the technologies that are used in this project, checkout the links below.

• ReactJS Official Docs
• NextJS Documentation
• Typescript Documentaion
• TailwindCSS Docs
• Material UI Documentaion

How to make a Contribution?

Never made an open source contribution before? And wondering how to contribute to this project? No worries! Here's a quick guide,

1. Choose any feature/bug you wish to contribute to.
2. Fork the repository into your own account.
3. Clone the repo you have forked in your local machine using git clone https://github.com/<Your-name>/ResumeWizard.git
4. Create a new branch for your fix by using the command git checkout -b YourName-branch-name
5. Make the changes you wish to do and stage them using the command git add files-you-have-changed or use git add .
6. Use the command git commit -m "Short description of the changes" to describe the changes you have done with a message.
7. Push the changes to your remote repository using git push origin your-branch-name
8. Submit a PR(pull request) to the upstream repository Aadarsh805/ResumeWizard with a title and a small description.
9. Wait for the pull request to be reviewed by us.
10. Make appropriate changes if the maintainer recommends you to and submit it.
11. Await for your contribution to be merged into the repository.

Checkout the Contributing.md file before contributing.

Where can I go for help?

If you need help, you can ask questions on our twitter :

• Aadarsh Thakur

Credits

License

MIT

Thanks to all the Contributors ❤️

Your Support means a lot

Give a ⭐ to the project if you liked it. :)