Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mmazzarolo/chrome-another-tab
Just building a Chrome Extension with Create React App and TypeScript.
https://github.com/mmazzarolo/chrome-another-tab
chrome-extension immer react redux typescript
Last synced: about 1 month ago
JSON representation
Just building a Chrome Extension with Create React App and TypeScript.
- Host: GitHub
- URL: https://github.com/mmazzarolo/chrome-another-tab
- Owner: mmazzarolo
- License: gpl-3.0
- Created: 2018-12-09T09:45:00.000Z (almost 6 years ago)
- Default Branch: develop
- Last Pushed: 2019-12-26T06:45:35.000Z (over 4 years ago)
- Last Synced: 2024-07-19T02:15:55.728Z (2 months ago)
- Topics: chrome-extension, immer, react, redux, typescript
- Language: TypeScript
- Homepage:
- Size: 6.34 MB
- Stars: 248
- Watchers: 6
- Forks: 21
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Another Tab - Chrome Extension 
An open source Chrome extension that shows your bookmarks when you open a new tab.
Built with Create React App and TypeScript.
Download Another Tab from the Chrome Web Store
## Overview
I initially built this extension just for personal use... and for trying building a Chrome extension 🤷♂️, so for now it has just the features that I need...
That said, PRs are welcome!
[Check the DEVLOG to see the history of the project](./DEVLOG.md).
### Features
- Shows your bookmarks in the new tab page
- Bookmarks filtering/search
- Keyboard navigation support
- Bookmark folders visibility toggle
- Themes support
- Drag & drop bookmark sorting
### Stack
- React (using Create React App) and hooks
- TypeScript
- Styled-Components
- Redux, Redux-Saga and Typesafe-Actions
## Contributing
### Feature request
I already created a few [issues](https://github.com/mmazzarolo/chrome-another-tab/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) with some features that I feel like would be really welcomed addition, and I'm open to any other additional suggestion... especially if you already have an idea to implement it's UI/UX.
### Developing locally
This is a standard Create React App, so you can easily start working on it by simply cloning the project and running `yarn` to install all its dependencies.
To develop the app locally you can run `yarn start`, I already included some fake bookmarks to simulate the production behaviour of the extension.
### Development tips
This app uses TypeScript, React Hooks, Redux and Styled-Components, so you might need to be confortable with these technologies to completely understand the codebase.
The app is still pretty simple, doesn't have too many components and most of the logic is just in the Chrome Bookmarks parsing and in the Redux sagas.
If you feel intimidated by the codebase **please just open an issue/send a PR**, I'm open to discussion and tips.
Also, if you're not confortable with hooks feel free to use class components.
### Chrome Web Store deployment
I setup a [semi-automated Chrome Web Store deployment using CircleCI](./.circleci/config.yml).
It currently runs only when the `master` branch receives a new push, but I still haven't automated the version number bumping (so I still have to do it manually).
It would be great making the publishing step manipulate the `manifest.json` so that it reflects the `package.json` version and/or a git tag.
### Live example deployment
The "live example" is just a customized version of the production build of the app deployed on GitHub Pages.
If you check the `gh-pages` script in the `package.json` you'll see that I'm setting a `REACT_APP_IS_LIVE_EXAMPLE` environment variable before running the GitHub Pages deployment: this will allow the build to use the fake bookmarks instead of trying to get them from the Chrome API (like if it was an extension running in the browser).
### GitHub organization?
If the app starts getting contributions I'll gladly create a new ad-hoc organization for it, instead of keeping it in my personal profile.