Skip to content
Firefox Screenshots: the best way to take screenshots on the web.
FreeMarker JavaScript Python CSS Shell Makefile Other
Branch: master
Clone or download

Latest commit

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Do stage deploy first, before other steps Feb 25, 2019
.postcss RTL major refactor (#5055) Oct 30, 2018
bin Also disable AMO-signed xpis Nov 12, 2019
docs Update Firefox release instructions for new phab review process Nov 11, 2019
locales Pontoon: Update Bengali (bn) localization of Firefox Screenshots Nov 15, 2019
server Merge pull request #5424 from mozilla-services/remove-heartbeat Dec 10, 2019
shared Fixes #4959 - Login flow should work from a non-Firefox browser (with… Oct 25, 2018
static Make the homepage entirely static Oct 1, 2019
test
webextension
.babelrc
.codecov.yml Change codecov.io to only report coverage changes (#3400) Aug 28, 2017
.dockerignore
.env.dev Submit shot image to Watchdog on save. (#4377) Jun 8, 2018
.eslintignore Migrate Screenshots to pure WebExtension (#4864) Sep 12, 2018
.eslintrc.yml Use double quotes. (#3977) Feb 2, 2018
.gitignore * added accessibility tests for home page Oct 5, 2018
.nsprc Fix npm audit fail issue 4803 (#4948) Sep 27, 2018
.sass-lint.yml clean up home Aug 10, 2017
.zap-baseline.conf Update ZAP command in circleci (#3321) Oct 16, 2017
CHANGELOG.md Update version with changelog Dec 19, 2019
CODEOWNERS Add flod as string owner. Fixes #3369 (#3475) Sep 8, 2017
CODE_OF_CONDUCT.md Add Mozilla Code of Conduct file Mar 28, 2019
CONTRIBUTORS.md Add a couple security bug contributors Jul 31, 2017
Dockerfile Do not copy the screenshots.xpi into the server Dec 19, 2019
LICENSE Initial commit Nov 18, 2014
Makefile Add package-lock.json to the dependencies on npm install (#5117) Oct 31, 2018
README.md Fixes #5420 - Update ReadMe (#5427) Jan 14, 2020
l10n.toml Rename bn-BD as bn, remove bn-IN (#5386) Jul 18, 2019
package-lock.json Update package-lock given updated dependencies Jan 24, 2019
package.json Update version with changelog Dec 19, 2019
pytest.ini Skip test_file_managemnt tests by default Dec 27, 2017
requirements.txt Update dependency requests to v2.21.0 Jan 13, 2019
setup.cfg * added npm script to run a11y tests Oct 25, 2018

README.md

Firefox Screenshots

CircleCI Build Status

Screenshots server status page

Clarifying the Future of Firefox Screenshots


This is a screenshot tool for Firefox. It is available in Firefox 56 and later versions, as part of the default Firefox distribution.

The project was initially launched through Test Pilot as Page Shot.

It is made up of both an add-on (using WebExtensions) and a website using Node.js. The add-on is in webextension/, and the website is in server/

Ian has been blogging about the design, definition, and development process.

(This project used to include general page freezing; this functionality has been forked off into pagearchive.)

You can find more information about Firefox Screenshots at the Mozilla Wiki page: https://wiki.mozilla.org/Firefox/Screenshots

Installation and Setup

Install Nightly or Developer Edition.

(Skip this step if you do not want to run a local server.) Install Postgres. And do one of the following:

Install Node.js. Version 8.x is required.

Clone the repository. Navigate to the project directory and run npm install.

There are two scripts to run the server locally and develop the add-on:

  • ./bin/run-server will run the server on http://localhost:10080 and automatically restart if there are changes.
    • If nodemon crashes you can try to start the server with ./bin/run-server --restart
    • Take a look at and/or source .env.dev for some of the options available through environment variables.
  • ./bin/run-addon will build a few parts of the addon (into addon/webextension/build/) and start Firefox with the add-on installed. The add-on will be refreshed automatically as you change files. We recommend you open about:debugging to help debug the extension.
  • ./bin/run-addon --setup-profile will setup a Firefox profile for your development; this way you can make persistent changes to the profile that you will use just for Screenshots development. (note: this will only look for the firefox command or Nightly, Developer Edition, Aurora editions on OSX)

If you want to develop the add-on but not the server you can run ./bin/run-addon -s https://screenshots.dev.mozaws.net

By default, Screenshots will connect to a Postgres database on localhost:5432. To change which database and user it connects to set/export the environmental variables: RDS_USERNAME, RDS_PASSWORD, and RDS_HOSTNAME

The server will automatically setup the tables in your database, and keep them up to date over time (using pg-patcher).

If you have growl and growlnotify installed on Mac OS X, you will get growl notifications when the server build has started and completed.

We apologize but we have no story for development on Windows (though the add-on runs on Windows). We welcome feedback.

Linting and Testing

npm run test will run tests as well as eslint. You can control the tests with the following shell/environment variables:

  • MOZ_HEADLESS - when this variable is set, the Selenium tests will run in headless mode.
  • SCREENSHOTS_BACKEND - the server where the addon will try to save shots if the default http://localhost:10080 is not available or desirable.

For example, MOZ_HEADLESS=1 SCREENSHOTS_BACKEND=https://screenshots.dev.mozaws.net npm run test will run the tests headlessly against https://screenshots.dev.mozaws.net.

npm run test:server will run the server tests. This require Python and the local server running on http://localhost:10080.

Getting to know the code

There is documentation in webextension/, webextension/background/, and webextension/selector/ that talks about the code layout and architecture of the webextension.

server/view-docs.md talks about how the server React pages are setup, along with the server-side rendering of pages.

There is also documentation in docs/.

Participation

There is an IRC channel #screenshots on irc.mozilla.org (you can use this link for chat access via the web if you do not otherwise use IRC). There are IRC logs available.

If you'd like to contribute code, start with our good-first-issue bugs. If there aren't many of them, or they don't seem too interesting, the Stretch milestone contains things we'd like to get to, but aren't a high priority. If you're interested in working on an issue, it's a good idea to comment in the issue on github, or say hello on IRC, so that we can double-check that the issue is still good, provide any context you might need, and assign it to you.

Planning and ideation is happening in the issue tracker. We have several milestones:

Issue tags otherwise aren't very structured. Research is primarily analysis of other products that do something interesting, or some source material that could provide insight. Input on these (things like "I like this product because...") is very helpful!

We do some research on other projects, collecting the results in this Google Drive folder.

Localization

Firefox Screenshots localization is managed via Pontoon, not direct pull requests to the repository. If you want to fix a typo, add a new language, or simply know more about localization, please get in touch with the existing localization team for your language, or Mozilla’s l10n-drivers for guidance.

You can’t perform that action at this time.