Skip to content

Commit

Permalink
added license file
Browse files Browse the repository at this point in the history
  • Loading branch information
mtnbarreto committed Jun 13, 2023
1 parent 37bd549 commit 8badcd9
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 10 deletions.
21 changes: 21 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Martin Barreto

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.
60 changes: 50 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,53 @@
# 🤖 Chrome Extension App - Modern Web bring to Chrome Extensions

Chrome Extension App uses the best web development practices and provide best DX. It enables developers to quicky develop chome extensions app, nowadays countless ML applications using LLM provides an browser extension app and this was my main motivations to build this boilerplate project.

![chrome extension DX](chrome-extension-app.png)

## 👨🏻‍💻 DX Capabilities

- 🗨️ Vite. Dev server, HMR (Hot module replacement), Rollup.
- 🫒 Vue3. Reactive, component-based framework for building web interfaces.
- 🤐 vite-plugin-zip-pack for creating chrome extension compressed zip to upload to store.
- 🇮🇹 Rome. Linter and Formatting.
- 🥓 crxjs vite plugin. Vite plugin that helps you make Chrome Extensions.
- 👩‍🎨 Postcss with autoprefixer and tailwindcss plugins

## 💻 Commands

In orden to use this template follow these steps:

1. Clone the repository.



2.


## 💚 Contributing

Contribute to the project by creating a pull request. Please follow these steps:

1. Fork the repository.
2. Clone the fork to your local machine.
3. Create a new branch from the main branch.
4. Make your changes and commit them.
5. Push your branch to your fork.
6. Create a pull request on this repository with a descriptive title and message.

Checkout the CONTRIBUTING.md file for more information.

## 🏉 License

Chrome Extension App is licensed under the [MIT License](https://https://github.com/mtnbarreto/chrome-extension-app/blob/main/LICENSE).








# Vue 3 + TypeScript + Vite

This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
Expand All @@ -16,13 +66,3 @@ If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has a
1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.



[Rome](https://rome.tools/) is used as the linter and formatter. To run the linter and formatter, run the following command:
```bash
yarn lint
```
```bash
yarn format
```

0 comments on commit 8badcd9

Please sign in to comment.