|
1 | | -# chrome-event-countdown |
2 | | - |
3 | | -## Project setup |
4 | | -``` |
5 | | -npm install |
6 | | -``` |
7 | | - |
8 | | -### Compiles and hot-reloads for development |
9 | | -``` |
10 | | -npm run serve |
11 | | -``` |
12 | | - |
13 | | -### Compiles and minifies for production |
14 | | -``` |
15 | | -npm run build |
16 | | -``` |
17 | | - |
18 | | -### Run your tests |
19 | | -``` |
20 | | -npm run test |
21 | | -``` |
22 | | - |
23 | | -### Lints and fixes files |
24 | | -``` |
25 | | -npm run lint |
26 | | -``` |
27 | | - |
28 | | -### Customize configuration |
29 | | -See [Configuration Reference](https://cli.vuejs.org/config/). |
| 1 | +# Chrome New Tab - Event Countdown |
| 2 | + |
| 3 | +A simple chrome extension for add event countdowns which will appear in the chrome new tab screen. |
| 4 | + |
| 5 | +| [](./images/new_tab.png) | [](./images/add_event.png) | |
| 6 | +|---|---| |
| 7 | + |
| 8 | +# Installation |
| 9 | +This isn't available on the Chrome store, so installation must be done manually. |
| 10 | + |
| 11 | +You can either download a zip with the prebuild extension from the [releases page](https://github.com/smithalan92/chrome-event-countdown/releases) |
| 12 | + |
| 13 | +Or else clone this repository and build it yourself ( steps towards the end of the readme ) and when it's build, follow the rest of the steps below. |
| 14 | + |
| 15 | +1. Download or build the extension as mentioned above. |
| 16 | +2. Move the exension directory in the zip, or your built one someplace you won't delete it. The extension directory will always need to be present on your computer for the extension to work. |
| 17 | +3. Go to chrome://extensions in Google Chrome. Enable developer mode up the top right if it's not already enabled. |
| 18 | +4. Click the "Load unpacked" button and select the extension directory you moved above. |
| 19 | +5. Finto, when you open the new tab screen you should now see a blank slate with an option to add an event. |
| 20 | + |
| 21 | +## Running/Building Locally. |
| 22 | +You should have Node v8+ and NPM V6+ |
| 23 | + |
| 24 | +1. Install the project dependencies by running `npm i` in the project folder. |
| 25 | +2. Start the local app server using `npm start` |
| 26 | + |
| 27 | +To build, simply run `npm run build` in the project directory. An `extension` folder will be generated in the project root folder. |
| 28 | + |
| 29 | +Note: When running locally, the browser localstorage API is used to store event data. When running as an extension in chrome, the chrome storage api is used. |
| 30 | + |
| 31 | +This project uses a lot of great third party modules. It's worth taking a look at the [package.json](./package.json) file and checking them out! |
0 commit comments