Requirements ✅

Node.js (Version > 16.x)

Run The Application ⚙️

1. Clone the project - git clone https://github.com/kd100100/react-gpt-reviewer.git
2. Enter folder - cd react-gpt-reviewer
3. Install dependencies - npm install
4. Create environment file - Refer .env.example and create .env file with OpenAI api key
5. Run Application - npm start

Status 🚧

GPT Reviewer project is still in progress. MVP will be out soon.

How to Contribute 👨‍💻

Thank you for your interest in contributing to our project! We welcome contributions from the community and are grateful for any time and effort you are willing to put in.

1. Fork the repository by clicking the "Fork" button in the top right corner of the page. This will create a copy of the repository in your own GitHub account.
2. Clone the repository to your local machine using git clone https://github.com/YOUR_USERNAME/react-gpt-reviewer.git.
3. Make the changes you would like to contribute. Be sure to follow the project's code style guidelines and ensure that your code is properly tested.
4. Commit your changes and push them to your forked repository using git commit -am "Commit message" and git push.
5. Go back to the original repository and create a pull request by clicking the "New pull request" button.
6. In the pull request, make sure to describe the changes you made and why you made them.
7. Submit the pull request and wait for it to be reviewed by the project maintainers.

Thank you again for your interest in contributing to our project! We look forward to reviewing your pull request.