steve/tok-to-insta-follower-bridge
1
0
Fork 0
mirror of https://github.com/snachodog/tok-to-insta-follower-bridge.git synced 2025-04-09 13:41:23 -06:00
Code Issues Packages Projects Releases Wiki Activity

📝 Documentation improvements

Browse Source 
Fix typos and improve wordings in README.md and CONTRIBUTING.md.

Additionally the `.idea` folder is added to .gitignore, to prevent WebStorm's temp files from being uploaded.
This commit is contained in:
Michal 2023-10-08 01:11:02 +02:00
parent f865d0d8c1
commit 68d32eb154
4 changed files with 51 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.gitignore vendored
View File

@ -1,4 +1,3 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
# dependencies # dependencies
@ -9,7 +8,7 @@
# testing # testing
/coverage /coverage
#cache # cache
.turbo .turbo
.next .next
.vercel .vercel
@ -24,9 +23,9 @@ yarn-debug.log*
yarn-error.log* yarn-error.log*
.pnpm-debug.log* .pnpm-debug.log*
# local env files # local env files
.env* .env*
.idea
out/ out/
build/ build/

71
CONTRIBUTING.md
View File

@ -5,74 +5,71 @@ Contributions are welcome 🎉
## Issues ## Issues
The following Issue is accepted. The following issues are accepted:
- Questions about features - Questions about features
- Report errors or problems - Reports of errors or problems
- Propose additions or improvements to feature - Proposals for new additions or improvements to features
Please click [here](https://github.com/kawamataryo/sky-follower-bridge/issues/new) to issue. Please click [here](https://github.com/kawamataryo/sky-follower-bridge/issues/new) to create an issue.
## Pull Request ## Pull Requests
Pull requests are always welcome. Pull requests are always welcome.
The following types of Pull Requests are accepted. For basic Pull Requests (especially minor ones), you may send a Pull Request without creating an Issue. The following types of pull requests are accepted. For basic pull requests (especially minor ones), you may send a pull request without creating an issue.
- Bug fixes
- New functionality
- Performance fixes
- Typo fixes
- Bug Fixes "How about this kind of fix/improvement?" - If you have a question, please create an issue and discuss it with me.
- Add functionality
- Performance Fixes
- Typo Fixes
"How about this kind of fix/improvement?" If you have a question, please raise an Issue and discuss it with me. ## How to create a Pull Request
## How to send Pull Request Please follow these steps to create a pull request:
Please follow these steps to create a pull request.
1. Fork the repository 1. Fork the repository
2. Create a branch 2. Create a new branch
3. Add or modify feature 3. Implement your changes
4. Run e2e and unit test 4. Run e2e and unit tests
5. Check the feature in your browser 5. Check the feature in your browser
5. Commit Changes 6. Commit changes
6. Push branch 7. Push branch
7. Create Pull Request 8. Create a Pull Request
Also, when creating a pull request, please keep the following in mind Additionally, when creating a pull request, please keep the following in mind:
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. - **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
- **Add tests!** - If you add a feature, it would be great if you could write a test for it. - **Add tests!** - If you add a feature, it would be great if you could write a test for it.
- **Keep the same style** - eslint will automatically be ran before committing - **Keep the same code style** - ESLint will automatically be run before committing.
- **Document any change in behavior** - Make sure the `README.md` and any other relevant documentation are kept up-to-date. - **Document any change in behavior** - Make sure the `README.md` and any other relevant documentation is kept up-to-date.
- **Send coherent history** - Make sure your commits message means something - **Send coherent history** - Make sure your commit messages are meaningful and self-explanatory.
## How to set up a local development environment
## How to set up a Local Development Environment First, clone the forked repository locally:
First, clone the forked repository locally.
```bash ```bash
$ git clone https://github.com/kawamataryo/sky-follower-bridge.git $ git clone https://github.com/kawamataryo/sky-follower-bridge.git
``` ```
Install dependent modules with npm. Install dependencies with npm:
If you do not have pnpm, please install it beforehand.
```bash ```bash
$ npm i $ npm i
``` ```
The dev command starts the development server. The dev command starts the development server:
```bash ```bash
$ npm run dev $ npm run dev
``` ```
When the development server starts, the Extension build results are output to the `extension`. When the development server starts, the extension build results are output to the `extension` directory.
You can use extensions in your browser by loading the contents of the extensions folder in Chrome Exteinsions. You can use the built extension in your browser by loading the contents of the extensions folder in Chrome:
<img width="600" alt="image" src="https://github.com/kawamataryo/sky-follower-bridge/assets/11070996/ac90d0de-8957-41d4-bb53-571583106040"> <img width="600" alt="image" src="https://github.com/kawamataryo/sky-follower-bridge/assets/11070996/ac90d0de-8957-41d4-bb53-571583106040">
@ -80,16 +77,18 @@ When you modify the code, the change is automatically reflected.
## Release ## Release
When the version file of [changesets](https://github.com/changesets/changesets) is merged into master, released to each store with a [GitHub Actions job](https://github.com/kawamataryo/sky-follower-bridge/blob/main/.github/workflows/publish.yml). When the version file of [changesets](https://github.com/changesets/changesets) is merged into master, a new version is released to each extension store with a [GitHub Actions job](https://github.com/kawamataryo/sky-follower-bridge/blob/main/.github/workflows/publish.yml).
1. add version file 1. add version file
```
```bash
npx changeset add npx changeset add
``` ```
2. git push 2. git push
```
```bash
git add .changesets git add .changesets
git commit -m "🛠️ add changeets" git commit -m "🛠️ add changesets"
git push origin master git push origin master
``` ```

23
README.md
View File

@ -1,31 +1,34 @@
# Sky Follower Bridge # Sky Follower Bridge
<a href="https://chrome.google.com/webstore/detail/sky-follower-bridge/behhbpbpmailcnfbjagknjngnfdojpko"><img alt="Chrome web store version" src="https://img.shields.io/chrome-web-store/v/behhbpbpmailcnfbjagknjngnfdojpko.svg"></a> <a href="https://chrome.google.com/webstore/detail/sky-follower-bridge/behhbpbpmailcnfbjagknjngnfdojpko"><img alt="Chrome web store version" src="https://img.shields.io/chrome-web-store/v/behhbpbpmailcnfbjagknjngnfdojpko.svg"></a>
<a href="https://chrome.google.com/webstore/detail/sky-follower-bridge/behhbpbpmailcnfbjagknjngnfdojpko"><img alt="Chrome web store rating" src="https://img.shields.io/chrome-web-store/stars/behhbpbpmailcnfbjagknjngnfdojpko.svg"></a> <a href="https://chrome.google.com/webstore/detail/sky-follower-bridge/behhbpbpmailcnfbjagknjngnfdojpko"><img alt="Chrome web store rating" src="https://img.shields.io/chrome-web-store/stars/behhbpbpmailcnfbjagknjngnfdojpko.svg"></a>
<a href="https://chrome.google.com/webstore/detail/sky-follower-bridge/behhbpbpmailcnfbjagknjngnfdojpko"><img alt="Chrome Web Store users" src="https://img.shields.io/chrome-web-store/users/behhbpbpmailcnfbjagknjngnfdojpko"></a> <a href="https://chrome.google.com/webstore/detail/sky-follower-bridge/behhbpbpmailcnfbjagknjngnfdojpko"><img alt="Chrome Web Store users" src="https://img.shields.io/chrome-web-store/users/behhbpbpmailcnfbjagknjngnfdojpko"></a>
Instantly find and follow the same users from your X(Twitter) follows on Bluesky.
Instantly find and follow the same users from your X(Twitter) follower on Bluesky.
https://github.com/kawamataryo/sky-follower-bridge/assets/11070996/0c87f9b9-573f-48c3-b7ba-f54e0e30a7e7 https://github.com/kawamataryo/sky-follower-bridge/assets/11070996/0c87f9b9-573f-48c3-b7ba-f54e0e30a7e7
## 📦 Installation ## 📦 Installation
- [Chrome Web Store](https://chrome.google.com/webstore/detail/sky-follower-bridge/behhbpbpmailcnfbjagknjngnfdojpko) - [Chrome Web Store](https://chrome.google.com/webstore/detail/sky-follower-bridge/behhbpbpmailcnfbjagknjngnfdojpko)
- [Firefox Add-ons](https://addons.mozilla.org/ja/firefox/addon/sky-follower-bridge/) - [Firefox Add-ons](https://addons.mozilla.org/ja/firefox/addon/sky-follower-bridge/)
## 🚀 How to use ## 🚀 How to use
1. Open your Twitter [Follower](https://twitter.com/following) or [Follow](https://twitter.com/followers) or [list members](), [blocking](https://twitter.com/settings/blocked/all) page.
2. Press `Alt + B` shortcut or click on the toolbar icon to launch the Sky Follower Bridge. 1. On Twitter open Your [Following](https://twitter.com/following), [Followers](https://twitter.com/followers), or [Blocked](https://twitter.com/settings/blocked/all) users list, or the Members page of a public List.
3. Input your Bluesky login email or handle and [App password](https://bsky.app/settings/app-passwords). 2. Use the `Alt + B` shortcut or click on the toolbar icon to launch the Sky Follower Bridge extension.
4. Execute the user search. 3. Input your Bluesky login email or handle and an [app password](https://bsky.app/settings/app-passwords).
5. Bluesky users will appear in the Follower list. 4. Execute the user search.
6. Click the Follow button to follow them on Bluesky. 5. Bluesky users will appear in the Follower list.
6. Click the "Follow" button to follow them on Bluesky.
## 🔧 Troubleshooting ## 🔧 Troubleshooting
- Please feel free to mention [@kawamataryo.bsky.social](https://bsky.app/profile/kawamataryo.bsky.social) on Bluesky. They will provide support to ensure the tool is functioning properly. - Please feel free to mention [@kawamataryo.bsky.social](https://bsky.app/profile/kawamataryo.bsky.social) on Bluesky. They will provide support to ensure the tool is functioning properly.
- If you get the error "Error: Something went wrong. ...", **please reload the page** and then click on the extension icon again. - If you get the error "Error: Something went wrong. ...", **please reload the page** and then click on the extension icon again.
## 🚨 Limitations ## 🚨 Limitations
Note that due to Twitter’s limitations, it’s not possible to search all Followers at once. If you want to search for more, click the Find More button that appears on the screen.
Note that due to Twitter’s limitations, it’s not possible to search all Followers at once. If you want to search for more, click the "Find More" button that appears on the screen.
![](https://github.com/kawamataryo/sky-follower-bridge/assets/11070996/98759f94-9d24-4ddc-bf7f-9ea94f577ede) ![](https://github.com/kawamataryo/sky-follower-bridge/assets/11070996/98759f94-9d24-4ddc-bf7f-9ea94f577ede)

2
package.json
View File

@ -2,7 +2,7 @@
"name": "sky-follower-bridge", "name": "sky-follower-bridge",
"displayName": "Sky Follower Bridge", "displayName": "Sky Follower Bridge",
"version": "0.6.5", "version": "0.6.5",
"description": "Instantly find and follow the same users from your Twitter follower on Bluesky.", "description": "Instantly find and follow the same users from your Twitter follows on Bluesky.",
"author": "kawamataryou", "author": "kawamataryou",
"scripts": { "scripts": {
"dev": "plasmo dev", "dev": "plasmo dev",