Skip to content

Commit

Permalink
Add Gitpod support to make contributions easier (PR #1671)
Browse files Browse the repository at this point in the history
  • Loading branch information
jankeromnes authored and julienw committed Feb 22, 2019
1 parent 9ca243a commit 7bfe91d
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 1 deletion.
8 changes: 8 additions & 0 deletions .gitpod.yml
@@ -0,0 +1,8 @@
ports:
- port: 4242
tasks:
- before: nvm install 10
init: yarn install
command: FX_PROFILER_HOST="0.0.0.0" yarn start
- openMode: split-right
command: printf "\nFirefox Profiler ❤ Gitpod\nWelcome to this virtual environment.\nYou can type your commands in this terminal.\n\n"
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Expand Up @@ -50,6 +50,14 @@ To get started clone the repo and get the web application started.
5. Point your browser to [http://localhost:4242](http://localhost:4242).
6. If port `4242` is taken, then you can run the web app on a different port: `FX_PROFILER_PORT=1234 yarn start`

## Using Gitpod

Alternatively, you can also develop the Firefox Profiler online in a pre-configured development environment:

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/firefox-devtools/profiler)

Gitpod will automatically install all dependencies; start the webpack server for you; and open the web app in a new browser tab.

## Loading in profiles for development

The web app doesn't include any performance profiles by default, so you'll need to load some in. Make sure the local Webpack web server is running, and then try one of the following:
Expand Down
4 changes: 4 additions & 0 deletions README.md
Expand Up @@ -38,6 +38,10 @@ yarn install
yarn start
```

You can also develop the Firefox Profiler online in a pre-configured development environment:

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/firefox-devtools/profiler)

For more detailed information on getting started contributing. We have plenty of docs available to get you started.

| | |
Expand Down
2 changes: 1 addition & 1 deletion server.js
Expand Up @@ -12,7 +12,7 @@ const localConfigExists = fs.existsSync(
);

const serverConfig = {
allowedHosts: ['localhost'],
allowedHosts: ['localhost', '.gitpod.io'],
contentBase: config.output.path,
publicPath: config.output.publicPath,
hot: process.env.NODE_ENV === 'development' ? true : false,
Expand Down

0 comments on commit 7bfe91d

Please sign in to comment.