Skip to content

Commit

Permalink
update docs to alleviate issues with legacy build vs new build (#120)
Browse files Browse the repository at this point in the history
  • Loading branch information
vujita authored Mar 2, 2021
1 parent 67944e3 commit 1e315bc
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 1 deletion.
14 changes: 14 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# This repository is currently migrating the build process

We are currently migrating from using [gulp](https://gulpjs.com/) -> [webpack](https://www.google.com/search?q=webpack&oq=webpack&aqs=chrome.0.69i59l3j69i60l3j69i61l2.1368j0j4&sourceid=chrome&ie=UTF-8) for asset bundling. The currently published build will be left in place until this is complete

![build locations](./screenshots/repo-build.png)

## Pre-requisites

- node v11.15.0
Expand All @@ -12,3 +18,11 @@ This will allow you to run varios tasks

In devmode you can open [local remote devtools](http://localhost:8000)
![remote redux devtools](./screenshots/remote-redux-devtools.png)

## Development instructions

```
nvm use
npm install
npm run dev
```
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ jsxhint --jsx-only .

There is a precommit hook that lints the code before commiting the changes.

### Load unpacked in Chrome
### Load unpacked in Chrome (current in chrome store)

1. Clone repository to disk
2. Remove `browser_specific_settings` key from manifest.json (only necessary for firefox)
Expand All @@ -73,8 +73,12 @@ There is a precommit hook that lints the code before commiting the changes.
5. Click `Load unpacked extension...`
6. Select repository directory

![load reportistory directory](./screenshots/load-repo-folder.png)

### Troubleshooting

Check for errors by inspecting the extension.

![inspecting extension](./screenshots/wakatime-chrome-debug.gif)

The extension is going through a refactor, the new build [instructions are here](./DEVELOPMENT.md)
Binary file added screenshots/load-repo-folder.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/repo-build.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1e315bc

Please sign in to comment.