Skip to content

iiitl/GitHub-Finder

Repository files navigation

Github Finder

Github Finder is a platform designed to assist individuals seeking team members for hackathons. The platform enables users to browse through potential team members' GitHub repositories, aiding in making informed decisions when forming teams. Users can assign two tags to themselves in the profile section, indicating their skills and making it easier for others to find them.

Getting Started

To run the project, follow these steps:

  1. Ensure you have Yarn or npm installed.
  2. If you're using Yarn, run yarn to install dependencies. If you're using npm, run npm install.
  3. If you're using Yarn, run yarn run dev to start the development server. If you're using npm, run npm run dev.

Important Notes

  • Port Requirement: Run the project exclusively on port 3000.
  • .env.local: Do not change or alter the .env.local file provided.
  • Chat/Socket Server: The server for the chat/socket is already made and deployed, so there's no need to worry about it as the chat system is fully functional.
  • Mongo Collection Password: The password for Akshat sir's MongoDB collection provided in the .env.local file is for a dummy collection, so there's no point in attempting to alter it.
  • Contact Information: For any inquiries or to report issues, contact Akshat sir directly at 8355847600.

Contact

For any questions or support, feel free to reach out to the project maintainer:

  • Maintainer: Akshat Bhansali
  • Contact: 8355847600

License

This project is licensed under the MIT License.

Releases

No releases published

Packages

No packages published

Languages