-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
120 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # Contribution Guidelines | ||
|
|
||
| Extro is an open source project, and contributions of any kind are welcome and appreciated. Open issues, bugs, and enhancements are all listed on the [issues](https://github.com/turbostarter/extro/issues) tab and labeled accordingly. Feel free to open bug tickets and make feature requests. Easy bugs and features will be tagged with the `good first issue` label. | ||
|
|
||
| ## Issues | ||
|
|
||
| If you encounter a bug, please file a [bug report](https://github.com/turbostarter/extro/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml&title=%5BBug%5D%3A+). If you have a feature to request, please open a [feature request](https://github.com/turbostarter/extro/issues/new?assignees=&labels=request&projects=&template=feature_request.yml&title=%5BFeature%5D%3A+). If you would like to work on an issue or feature, there is no need to request permission. | ||
|
|
||
| ## Pull Requests | ||
|
|
||
| In order to create a pull request for Extro, follow the GitHub instructions for [creating a pull request from a fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork). Please link your pull request to an existing issue. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| <div align="center"> | ||
|
|
||
| <br /> | ||
| <br /> | ||
|
|
||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" width="700" srcset="https://github.com/user-attachments/assets/09cf4bfb-36a5-4eda-a892-4ba737d6a531" /> | ||
| <source media="(prefers-color-scheme: light)" width="700" srcset="https://github.com/user-attachments/assets/7ccbabbf-5ddd-4cf0-9e44-cfbc5ba72e06" /> | ||
| <img alt="Logo" width="700" src="https://github.com/user-attachments/assets/09cf4bfb-36a5-4eda-a892-4ba737d6a531" /> | ||
| </picture> | ||
|
|
||
| <br /> | ||
| <br /> | ||
| <br /> | ||
|
|
||
|  | ||
|  | ||
|  | ||
|
|
||
|  | ||
|  | ||
|
|
||
|  | ||
| <a href="https://discord.gg/KjpK2uk3JP" target="_blank"><img src="https://discord.com/api/guilds/1280456871693779006/widget.png"/></a> | ||
|
|
||
|
|
||
| </div> | ||
|
|
||
| <p align="center"> | ||
| <a href="#features"><strong>Features</strong></a> · | ||
| <a href="#tech-stack"><strong>Tech stack</strong></a> · | ||
| <a href="#contributing"><strong>Contributing</strong></a> · | ||
| <a href="#getting-started"><strong>Getting started</strong></a> · | ||
| <a href="#community"><strong>Community</strong></a> · | ||
| <a href="#star-history"><strong>Star History</strong></a> | ||
| </p> | ||
|
|
||
|
|
||
| Everything you need to build a production ready browser extension, it's a **opinionated** stack based on learnings from building multiple browser extensions using the latest React framework. It's a starter kit with a focus on code reuse and best practices that will grow with your business. | ||
|
|
||
|
|
||
|
|
||
| ## Features ✨ <a name="features"></a> | ||
|
|
||
| 🔒 Full type-safety with Typescript <br /> | ||
| 📄 All pages (background, popup, options etc.) <br /> | ||
| 📜 Content scripts <br /> | ||
| 🔐 Authentication (OAuth) <br /> | ||
| 💾 Storage <br /> | ||
| 💬 Messaging <br /> | ||
| 🔥 Hot reloading <br /> | ||
| 🚀 One-click publishing <br /> | ||
| 🌍 Internationalization <br /> | ||
| 📊 Analytics <br /> | ||
| ✨ Linting and formatting <br /> | ||
| 🔄 CI/CD pipelines <br /> | ||
| ⚙️ Environment variables <br /> | ||
| 🎨 shadcn/ui compatible <br /> | ||
| 🔤 Custom fonts <br /> | ||
| 🤖 AI integration (experimental) <br /> | ||
| 💳 Billing (coming soon) | ||
|
|
||
| ## Tech stack 🛠️ <a name="tech-stack"></a> | ||
|
|
||
| | Tech | Description | | ||
| | ---------------------------------------------- | ----------------------------------------------------------------------------- | | ||
| | [TypeScript](https://www.typescriptlang.org/) | Static type-checking programming language | | ||
| | [React](https://reactjs.org/) | Library for building user interfaces | | ||
| | [Plasmo](https://www.plasmo.com/) | Next.js for browser extensions | | ||
| | [Supabase](https://supabase.com/) | Open source Firebase alternative | | ||
| | [shadcn/ui](https://ui.shadcn.com/) | Extendable component library | | ||
| | [Tailwind](https://tailwindcss.com/) | Utility-first CSS framework | | ||
| | [OpenPanel](https://openpanel.dev/) | Open source analytics | | ||
| | [React Hook Form](https://react-hook-form.com) | Forms with easy-to-use validation | | ||
| | [Bun](https://bun.sh/) | Package manager and build tool | | ||
| | [Husky](https://github.com/typicode/husky) | Git hooks | | ||
| | [Biome](https://biomejs.dev/) | Linting and formatting | | ||
|
|
||
| ## Contributing 🤝 <a name="contributing"></a> | ||
|
|
||
| Please read [CONTRIBUTING.md](./CONTRIBUTING.md). | ||
|
|
||
| ## Getting started 🚀 <a name="getting-started"></a> | ||
|
|
||
| TBD. | ||
|
|
||
| ## Community 💬 <a name="community"></a> | ||
|
|
||
| To chat with other community members, you can join the [Discord](https://discord.gg/KjpK2uk3JP) server. | ||
| You can ask questions on that server, and you can also help others. | ||
|
|
||
| Also, suggest new features or share any challenges you've faced while developing Chrome extensions! | ||
|
|
||
| ## Star History 🌟 <a name="star-history"></a> | ||
|
|
||
| <a href="https://star-history.com/#turbostarter/extro&Date"> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=turbostarter/extro&type=Date&theme=dark" /> | ||
| <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=turbostarter/extro&type=Date" /> | ||
| <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=turbostarter/extro&type=Date" /> | ||
| </picture> | ||
| </a> | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| Made with ❤️ by [Bartosz Zagrodzki](https://zagrodzki.me) |