GitHub E-Mail Exposer is a web application that allows you to find all e-mail addresses associated with a certain GitHub account. It retrieves event data from GitHub's public API to expose e-mail addresses that are not explicitly hidden by users. These e-mail adresses are public anyway, so nothing illegal is happening here 😎
- Search for GitHub users by username
- Display e-mail addresses of the searched user and their collaborators
- Copy e-mail addresses to clipboard with a single click
- Responsive design for various screen sizes
- 60 requests per hour for free
- React
- TypeScript
- Tailwind CSS
- Vite
I might add unit tests with Vitest on a later stage.
Before you begin, ensure you have met the following requirements:
- Node.js (v14.0.0 or later)
- npm (v6.0.0 or later)
- Clone the repository:
git clone https://github.com/raffael-87/github-email-exposer.git - Navigate to the project directory:
cd github-email-exposer - Install the dependencies:
npm install
To run the application in development mode: npm run dev
The application will be available at http://localhost:5173 (or another port if 5173 is in use).
To create a production build: npm run build
The built files will be in the dist directory.
Pull requests are warmly welcomed and appreciated 🙂
Please follow these steps:
- Fork the repository.
- Create a new branch:
git checkout -b <branch_name>. - Make your changes and commit them:
git commit -m '<commit_message>' - Push to the original branch:
git push origin <project_name>/<location> - Create the pull request.
Alternatively, see the GitHub documentation on creating a pull request.
This project is licensed under the MIT License.
You can find and message me on LinkedIn, so I know who you are 🧐