🚀Open Source Pal
Open Source Pal is a web extension built to help beginners in tech get into open source.
⚒️ Languages / Tools
- TypeScript
- React
- Tailwind
- Webextension-polyfill
👇🏽 Prerequisites
Before installation, please make sure you have already installed the following tools:
How to Use
- install it Chrome Link, other browsers coming soon
- click on the icon in your extension list
- sign in to github
- it will ask for an access code, ask on the discord server in #-coding-talk channel
- go to github and go to any project you want to contribute to
- check for an open icon close to your profile picture for github(if you can't see it, refresh the page)
Contribute
🛠️ Installation Steps
- Fork the repo
- Clone the repository
git clone https://github.com/<your-username>/OpenSourcePal.git
- Run
npm install
npm install -g commitizen
- Fill in the .env with the .env_sample
- learn how to get a github id & secret in the field of Authorization callback URL use the video below to know how https://github.com/OpenSourcePal/OpenSourcePal/assets/78784850/a7f5f28f-59df-4b51-a05a-0264d8a817cd
- Get the api key
- For the server url run the backend code
- Run
npm run dev:{the browser you use}
EX:npm run dev:chrome
npm run dev:{the browser you use}
🥂 After making a change
- Create a new branch
git checkout -b YourBranchName
- Add it to staging area
NOTE: don't commit the package.json
git add <path to the file you worked on>
- Commit your changes with
git cz
- Push your changes
git push
Load the extension in Chrome & Opera
- Open Chrome/Opera browser and navigate to chrome://extensions
- Select "Developer Mode" and then click "Load unpacked extension..."
- From the file browser, choose to
OpenSourcePal/dev/chrome
or > (OpenSourcePal/dev/opera
)
Load the extension in Firefox
- Open Firefox browser and navigate to about:debugging
- Click "Load Temporary Add-on" and from the file browser, choose
OpenSourcePal/dev/firefox
Load the extension in Edge
https://docs.microsoft.com/en-us/microsoft-edge/extensions/guides/adding-and-removing-extensions>
Available Target Browsers
chrome
firefox
opera
edge
👨👩👦 Community
If you have any questions or comments, I'd be happy to hear your thoughts. on our discord community - Join us
👩🏽💻 Contributing
- Contributions make the open source community such an amazing place to learn, inspire, and create.
- Any contributions you make are greatly appreciated.
- Check out our contribution guidelines for more information.
🛡️ License
Code-Magic is licensed under the MIT License - see the LICENSE file for details.
💪🏽 Thanks to all Contributors
Thanks a lot for spending your time helping Code-Magic grow. Thanks a lot! Keep rocking🍻
🙏🏽 Support
This project needs a star️ from you. Don't forget to leave a star✨