README.md 2.37 KB
Newer Older
Fonner Development's avatar
Fonner Development committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# Shared Slides Clicker for Google Meet

Allows multiple users to control a Google Slides presentation from within Google Meet

🔨 Made by [@jedfonner](https://jedfonner.com)

  <a href='https://www.buymeacoffee.com/jedfonner' target='_blank'>
    <img height='36' style='border:0px;height:36px;' src='https://bmc-cdn.nyc3.digitaloceanspaces.com/BMC-button-images/custom_images/orange_img.png' border='0' alt='Buy Me a Coffee' />
  </a>

## Features

#### User Features

See https://fonner.gitlab.io/shared-slides-clicker/

#### Developer Features

- Cross Browser Support (Web-Extensions API)
- Automatic build on code changes
- SASS styling
- ES6 modules support
- React UI Library
- Smart reload

26
**Note**: building for Firefox isn't supported. The extension doesn't work in Firefox because Firebase Google Auth currently doesn't support Firefox extensions 🤕. The extension has not been tested in Opera.
Fonner Development's avatar
Fonner Development committed
27
28
29
30
31
32
33

Built on top of the amazing 🚀 [web-extension-starter](https://github.com/abhijithvijayan/web-extension-starter)

## 🏃‍ Quick Start

Ensure you have

34
- [Node.js](https://nodejs.org) 14+ installed
Fonner Development's avatar
Fonner Development committed
35
36
37

Then run the following:

38
39
40
- `npm install` to install dependencies.
- `npm start` to start the development server for chrome extension
- `npm run build` to build chrome extension
Fonner Development's avatar
Fonner Development committed
41
42
43

## Development

44
- `npm install` to install dependencies.
Fonner Development's avatar
Fonner Development committed
45
46
- To watch file changes in development

47
  - `npm start`
Fonner Development's avatar
Fonner Development committed
48

49
- Load extension in Chrome:
Fonner Development's avatar
Fonner Development committed
50

51
52
53
54
  - Go to the browser address bar and type `chrome://extensions`
  - Check the `Developer Mode` button to enable it.
  - Click on the `Load Unpacked Extension…` button.
  - Select the `extension/chrome` directory.
Fonner Development's avatar
Fonner Development committed
55
56
57

## Production

58
- `npm run build` builds the extension to the `extension/chrome.zip`.
Fonner Development's avatar
Fonner Development committed
59
60
61
62
63
64
65
66
67
68
69
70

Note: By default the `manifest.json` is set with version `0.0.0`. The webpack loader will update the version in the build with that of the `package.json` version. In order to release a new version, update version in `package.json` and run script.

If you don't want to use `package.json` version, you can disable the option [here](https://github.com/abhijithvijayan/web-extension-starter/blob/e10158c4a49948dea9fdca06592876d9ca04e028/webpack.config.js#L79).

## More Info

See [web-extension-starter](https://github.com/abhijithvijayan/web-extension-starter/blob/react-typescript/README.md) for more development information.

## License

MIT © [Jed Fonner](https://jedfonner.com)