Skip to content

Latest commit

 

History

History
93 lines (54 loc) · 2.94 KB

README.md

File metadata and controls

93 lines (54 loc) · 2.94 KB

DevFinder

DevFinder is a web application that simplifies the process of discovering GitHub developers and exploring their profiles. Developed with Next.js, TypeScript, and Tailwind CSS, DevFinder delivers a smooth and efficient user experience. It utilizes the GitHub API to retrieve developer information, presenting it in a sleek and responsive user interface.

Features

  • GitHub Developer Search: Users can easily search for GitHub developers by entering their usernames. The application retrieves and showcases the developer's profile information.

  • Theme Toggle: DevFinder offers a theme toggle feature, allowing users to switch between light and dark themes. This enhances user customization and provides a visually appealing experience.

  • Responsive Design: The application is designed to be responsive, ensuring a consistent and user-friendly experience across various devices and screen sizes.

  • History Section: DevFinder includes a history section that tracks previously searched developers. This feature facilitates quick access to past searches.

Getting Started

To run the DevFinder application locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/0ME9A/devfinder.git

  2. Navigate to the project directory:

    cd devfinder

  3. Install dependencies:

    npm install

  4. Run the development server:

    npm run dev

    This will start the development server, and you can access the application at http://localhost:3000 in your web browser.

Technologies Used

  • Next.js: A React framework for building server-side rendered and static web applications.

  • TypeScript: A superset of JavaScript that adds static typing to the language.

  • Tailwind CSS: A utility-first CSS framework for building modern and responsive user interfaces.

  • GitHub API: The official GitHub REST API used to fetch developer data.

Contributing

Thank you for considering contributing to DevFinder! Please follow these guidelines:

  1. Fork the repository.

  2. Create a new branch:

    git checkout -b feature/new-feature

  3. Make your changes and commit them:

    git commit -m "Add new feature"

  4. Push to the branch:

    git push origin feature/new-feature

  5. Open a pull request.

Read our contribution guidelines for more details.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Issues

If you encounter any issues or have suggestions for improvements, feel free to open an issue.

License

This project is licensed under the MIT License.