diff --git a/License b/License new file mode 100644 index 0000000..acc8e6f --- /dev/null +++ b/License @@ -0,0 +1,22 @@ +Copyright (c) 2017 GitHub, Inc. + +Permission is hereby granted, free of charge, to any person +obtaining a copy of this software and associated documentation +files (the "Software"), to deal in the Software without +restriction, including without limitation the rights to use, +copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..c8e2ed4 --- /dev/null +++ b/Readme.md @@ -0,0 +1,52 @@ +# GitHub Chrome Extension + +This Chrome extension allows users to subscribe to repositories for push and pull request notifications. +Note: Intially this was a complete extension but later on this push notification service has been migrated from the extension to the web due to new Chrome Manifest V3 restrictions that do not support non-Google authentication logins. + +## Features + +- Subscribe to repositories to receive notifications for push and pull requests. +- Integrated with GitHub API for real-time updates. +- Built with Vite React, Node.js with Express, and TypeScript. + +## Installation + +1. Clone the repository: + + ```bash + git clone https://github.com/your-username/github-chrome-extension.git + cd github-chrome-extension + ``` + +2. Install dependencies using npm in both client/ and server/: + + ```bash + npm install + ``` + +3. Create a .env file based on .env.example and configure your environment variables. + +4. Install dependencies using npm in both client/ and server/: + + ```bash + npm run dev + ``` + +## Screenshots + +![Dashboard Screenshot 2](images/image-1.png) +![Dashboard Screenshot 2](images/image.png) +![Pull Req](images/Pull_Req.jpg) +![Push](images/pushNotif.jpg) + +## Contributing + +Contributions are welcome! Please fork this repository and submit a pull request. + +## License + +This project is licensed under the MIT License - see the LICENSE file for details. + +
+ Made with ❤ by Vishnu +
diff --git a/client/.env.example b/client/.env.example new file mode 100644 index 0000000..ae38480 --- /dev/null +++ b/client/.env.example @@ -0,0 +1,10 @@ +VITE_GITHUB_CLIENT_ID = +VITE_SERVER = +VITE_PUBLIC_VAPID_KEY = +VITE_FIREBASE_API_KEY= +VITE_FIREBASE_AUTH_DOMAIN= +VITE_FIREBASE_PROJECT_ID= +VITE_FIREBASE_STORAGE_BUCKET= +VITE_FIREBASE_MESSAGING_SENDER_ID= +VITE_FIREBASE_APP_ID= +VITE_FIREBASE_MEASUREMENT_ID= \ No newline at end of file diff --git a/client/dist.zip b/client/dist.zip deleted file mode 100644 index edf2283..0000000 Binary files a/client/dist.zip and /dev/null differ diff --git a/images/Pull_Req.jpg b/images/Pull_Req.jpg new file mode 100644 index 0000000..1f2c06e Binary files /dev/null and b/images/Pull_Req.jpg differ diff --git a/images/image-1.png b/images/image-1.png new file mode 100644 index 0000000..c96b15d Binary files /dev/null and b/images/image-1.png differ diff --git a/images/image.png b/images/image.png new file mode 100644 index 0000000..e5a7176 Binary files /dev/null and b/images/image.png differ diff --git a/images/pushNotif.jpg b/images/pushNotif.jpg new file mode 100644 index 0000000..1f2c06e Binary files /dev/null and b/images/pushNotif.jpg differ diff --git a/server/.env.example b/server/.env.example new file mode 100644 index 0000000..e3083e2 --- /dev/null +++ b/server/.env.example @@ -0,0 +1,16 @@ +PORT = +# Firebase +API_KEY= +AUTH_DOMAIN= +PROJECT_ID= +STORAGE_BUCKET= +MESSAGING_SENDER_ID= +APP_ID= +MEASUREMENT_ID= +# Github +GITHUB_CLIENT_ID = +GITHUB_CLIENT_SECRET = +WEBHOOK_URL = +PUBLIC_VAPID_KEY = +PRIVATE_VAPID_KEY = +FIREBASE_SECRET = \ No newline at end of file