MrJeyhun / explainme

Get a readable explanation of any code snippet from Github with special analyzer API provided by Open AI

Explainme

◦ Developed with the software and tools listed below:

---

📒 Table of Contents

• 📒 Table of Contents
• 🚀 Getting Started
• 🤝 Contributing

🚀 Getting Started

📦 Installation

1. Clone the explainme repository:

git clone https://github.com/MrJeyhun/explainme.git

2. Install the dependencies:

npm install

3. Prisma Generate:

npx prisma generate 

🎮 Using explainme

1. Starting application:

npm start

2. Search repository, or select one from popular repositories section, open any file, highlight code piece, then click 'Explain Code' button. Ta Da! AI will analyze code piece and explain it.

🧪 Running Tests

npm test

🤝 Contributing

Contributions are always welcome! Please follow these steps:

1. Fork the project repository. This creates a copy of the project on your account that you can modify without affecting the original project.
2. Clone the forked repository to your local machine using a Git client like Git or GitHub Desktop.
3. Create a new branch with a descriptive name (e.g., new-feature-branch or bugfix-issue-123).

git checkout -b new-feature-branch

4. Make changes to the project's codebase.
5. Commit your changes to your local branch with a clear commit message that explains the changes you've made.

git commit -m 'Implemented new feature.'

6. Push your changes to your forked repository on GitHub using the following command

git push origin new-feature-branch

7. Create a new pull request to the original project repository. In the pull request, describe the changes you've made and why they're necessary. The project maintainers will review your changes and provide feedback or merge them into the main branch.