Skip to content

akunbeben/peek-repo

Repository files navigation

PeekCode - is a secure way to share your private repository with others.

What is this project about?

This project is a secure solution that allows you to share direct links to your private GitHub repositories without changing their visibility or inviting collaborators. By using Signed URLs, access to your code is restricted to a set period, ensuring your project remains confidential.

Who is this project for?

  • Jobseekers: If you're looking for a job, this project lets you share your coding portfolio selectively with recruiters or potential employers without exposing all your private repositories.
  • Students: For students or learners, this service enables you to showcase your projects or portfolio work to professors, mentors, or prospective employers while keeping your private work secure.

What we offers in this project?

  • Security: Signed URLs grant access for a limited time, reducing the risk of unauthorized access.
  • Privacy: You don't need to make your repositories public or add collaborators just for showcasing your work.
  • Ease of Sharing: Simply share one temporary link, allowing recruiters or mentors to view your project without any complicated processes.
  • Access Control: You can determine how long the access lasts (e.g., 1, 3, or 7 days), ensuring that access to your code is only available for as long as needed.
  • Limited Interaction: Note: Visitors do not need to and cannot clone the repository, ensuring that your source code remains protected even when accessed via the shared link.

How does it work?

  1. Authentication: Log in using GitHub OAuth so the system can securely access your repository data.
  2. Add fine-grained token Create a new fine-grained token and save it our system.
  3. Select a Repository: Choose the private repository you wish to share from a list of your repositories.
  4. Generate a Signed URL: The system generates a Signed URL. This URL is valid only for the duration you specify.
  5. Share the Link: Send the link to recruiters, professors, mentors, or anyone you wanted to share with. Visitor can access your repository only within the designated time frame, and they cannot clone or download the repository content.

What are the benefits of using this solution?

  • Enhanced Security: Only individuals with the link and within the valid time frame can access your code.
  • Preserve Repository Privacy: Keep your repositories private without altering their settings.
  • Improve Your Portfolio: For jobseekers and students, it's a professional way to showcase your coding skills without compromising project confidentiality.
  • Controlled Access: Visitors can only view the repository content through a secured interface, without the ability to clone or download the repository.

About

A secure way to share your private repositories.

Resources

Stars

Watchers

Forks

Contributors