added readme and contributing file

CONTRIBUTING.md

@@ -0,0 +1,123 @@
+# FindIssues contributing guidelines
+
+Thank you for taking the time to contribute to our project. Please take a moment to read the following guidelines before contributing:
+
+> ⚠️IMPORTANT **Note**
+>
+> **Pull Requests having no issue associated with them will not be accepted. Firstly get an issue assigned, whether it's already opened or raised by you, and then create a Pull Request.**
+
+
+## Prerequisites
+
+- Open Source Etiquette: If you've never contributed to an open source project before, have a read of [Basic etiquette](https://developer.mozilla.org/en-US/docs/MDN/Community/Open_source_etiquette) for open source projects.
+
+- Basic familiarity with Git and GitHub: If you are also new to these tools, visit [GitHub for complete beginners](https://developer.mozilla.org/en-US/docs/MDN/Contribute/GitHub_beginners) for a comprehensive introduction to them
+
+- [Node.js](https://nodejs.org/) is installed.
+
+---
+
+## How to Contribute 🤔
+
+We believe in the power of collaboration, and your contributions can help make FindIssues even more amazing. Whether you\`re a developer, designer, tester, or just enthusiastic about improving FindIssues, there are several ways you can contribute:
+
+#### 1. Code Contributions
+
+- **Bug Fixes:** Help us squash bugs by submitting detailed bug reports or fixing them yourself and opening a pull request.
+
+- **Feature Development:** If you have ideas for new features or improvements, let us know or dive right in and start coding.
+
+- **Enhancements:** Help us optimize and enhance existing features to make FindIssues smoother and more user-friendly.
+
+#### 2. Documentation
+
+- **Improvements:** Contribute to our documentation by suggesting edits, adding missing information, or writing new guides.
+
+#### 3. Testing
+
+- **Quality Assurance:** Help us ensure FindIssues is robust and reliable by testing new features and reporting any issues you find.
+
+#### 4. Spread the Word
+
+- **Tell Others:** If you enjoy using FindIssues, spread the word to your friends and on social media. The more, the merrier!
+
+#### Getting Started
+
+
+To start contributing, follow these steps:
+
+1. **Fork the Repository:** 
+
+    - Fork the FindIssues repository to your GitHub account.
+
+2. **Clone the Repository**: 
+
+   ```sh
+   git clone https://github.com/<your-username>/findissues.git
+   ```
+
+3. **Install Dependencies:**:
+
+    ```sh
+    cd findissues
+    npm install      
+    ```
+
+4. **Set Up GitHub API Token:**
+
+    - Visit GitHub Developer Settings to generate a personal access token.
+    - Create a `.env.local` file in the project root and add your token as follows:
+
+    ```sh
+    NEXT_PUBLIC_ACCESS_TOKEN=your-personal-access-token
+    ```
+
+5. **Start the Application:**
+
+    ```sh
+    npm run dev
+    ```
+
+6. **Open in Browser:**
+
+    - Visit http://localhost:3000 in your web browser to start exploring GitHub issues.
+
+7. **Create Branch:**
+
+    - Create a new branch for your contribution
+
+    ```sh
+    git checkout -b <your-branch-name>
+    ```
+
+8. **Make Changes:** 
+
+    - Make your changes, whether it`s code, documentation, or testing.
+
+9. **Stage Changes:** 
+
+    - Stage your changes
+
+    ```sh
+     git add <changed-file-name>
+    ```
+
+10. **Commit your changes:**
+
+    ```sh
+    git commit -m "Add your meaningful commit message here"
+    ```
+
+11. **Push Changes:** 
+
+    - Push your changes to your fork on GitHub
+
+    ```sh
+    git push origin <your-branch-name>
+    ```
+
+12. Open a pull request from your branch to the main FindIssues repository.
+
+Our team will review your contribution, provide feedback, and merge it once it meets our standards.
+
+Let's make FindIssues even better together! Your contributions are greatly appreciated. 🚀🙌

README.md

@@ -1,38 +1,35 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# Welcome to FindIssues ✨👋
 
-## Getting Started
+![FindIssues_banner](FindIssues_banner.png)
 
-First, run the development server:
+**FindIssues** is a dynamic web application that enables you to find the most recent unassigned issues across GitHub repositories. This project is powered by Next.js and the GitHub REST API, with a user-friendly interface designed using Adobe XD.
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-```
+## Features 🎯
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+- **Advanced Search**: Utilize advanced search techniques to filter and discover unassigned GitHub issues.
+- **Real-time Data**: Get access to the latest issue information directly from GitHub.
+- **User-Friendly Design**: Enjoy an intuitive and visually appealing interface designed with Adobe XD.
 
-You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
+## Live Demo 😀
+Visit our [**live demo**](https://findissues.vercel.app) to experience Muzical in action. Invite your friends and start watching videos together right now!
 
-[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
+## Tech Stack ⚙️
+![Javascript](https://img.shields.io/badge/JavaScript-ES6-yellow?style=for-the-badge&logo=javascript "Javascript") ![Nex.js](https://img.shields.io/badge/Next.js-React_Framework-000?style=for-the-badge&logo=next.js "Nex.js") ![Tailwindcss](https://img.shields.io/badge/Tailwind_CSS-CSS_Framework-38B2AC?style=for-the-badge&logo=tailwind-css "Tailwindcss")
 
-The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
+## How to Use
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
 
-## Learn More
 
-To learn more about Next.js, take a look at the following resources:
+## Contributing 🚀
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+We welcome contributions from the community to make Muzical even better. If you`re interested in contributing, please follow our [Contributing Guidelines](CONTRIBUTING.md) to get started.
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+## Acknowledgments 👀
 
-## Deploy on Vercel
+- Thanks to the GitHub API for providing real-time data.
+- Adobe XD for assisting in the design of the user interface.
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+## Contact 📧
+Got questions or feedback? Reach out to us through [**mail**](mailto:[email protected]). We\`d love to hear from you!
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+Join the FindIssues community today and start making search of un-assigned github issues more easier. 🧑‍💻✨👫