Skip to content

Commit 027cbe4

Browse files
author
Adam Spiers
committed
Document how to build from source
As mentioned in #253, without simple instructions on how to build Reactime from source, the fantastic developer docs in src/README.md are largely ineffective. So add the steps to this developer README. #254 already takes care of making this README more discoverable. Partially addresses #253.
1 parent 16879fb commit 027cbe4

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,15 @@ To get started, install the Reactime [extension](https://chrome.google.com/webst
5959

6060
NOTE: The React Developer Tools [extension](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en) is also required for Reactime to run, if you do not already have it installed on your browser.
6161

62-
### <b>Alternative Installation</b>
62+
### Installation
6363

6464
Use `src/extension/build/build.zip` for manual installation in [Developer mode](https://developer.chrome.com/extensions/faq#faq-dev-01). Turn on 'Allow access to file URLs' in extension details page if testing locally.
6565

66+
### Building from source
67+
68+
Please see [the developer README](src/README.md) for instructions on building
69+
from source.
70+
6671
## <b>How to Use</b>
6772

6873
After installing the Chrome extension, just open up your project in the browser.

src/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,18 @@
33
## Brief
44
Our mission at Reactime is to maintain and iterate constantly, but never at the expense of future developers.<br />We know how hard it is to quickly get up to speed and onboard in a new codebase.<br />So, here are some helpful pointers to help you hit the ground running. 🏃🏾💨
55

6+
## Building from source
7+
8+
1. If you have already installed Reactime from the Chrome Web Store, disable or uninstall it.
9+
2. Run `yarn` to install all dependencies.
10+
3. Run `yarn dev`. This will start a `webpack` process which watches for file changes and whenever it sees some, automatically rebuilds the webpack bundles used by the extension.
11+
4. Go to `chrome://extensions`
12+
5. Ensure Developer mode is enabled
13+
6. Click `Load unpacked`
14+
7. Select the `src/extension/build` directory
15+
16+
Now you should be able to change Reactime code and see the changes instantly reflected in your browser!
17+
618
## Quick Tips
719
- _Before_ beginning development, especially on teams, make sure to configure your linter and code formatting to conform to one unified setting (We recommend [the Airbnb style guide](https://github.com/airbnb/javascript)!) This will make reviewing PRs much more readable and less error-prone.
820

0 commit comments

Comments
 (0)