This guide walks through getting a development environment set up
to allow you to contribute to Fjord.
This definitely works for Mac OSX and Linux and probably works for
Windows, too. If you have issues, please let us know.
Download and install git if you don’t have it already:
Windows users: When you install git, make sure to choose
“Checkout as-is, commit Unix-style line endings”. If you don’t,
then you’ll end up with Windows-style line endings in your
checkout and Fjord won’t work in the virtual machine.
Download and install VirtualBox if you don’t have it already:
Download and install Vagrant if you don’t have it already:
You might have to close your terminal and start a new one to
pick up changes to PATH or other things in the environment after
installing these so that they’re available.
If you have a GitHub account, you should fork the Fjord repository and
then clone your fork:
git clone https://github.com/<USERNAME>/fjord.git
If you do not have a GitHub account, that’s ok! Clone the official
Fjord repository this way:
git clone https://github.com/mozilla/fjord.git
This creates a directory called
fjord/. We’ll call that the “Fjord
repository top-level directory”.
This will build a VirtualBox vm using Vagrant. The vm will have Ubuntu
Linux Trusty 14.04 installed in it. Fjord works in this environment.
Setting up Fjord in Vagrant takes at least 15 minutes and possibly
more depending on your network connection.
Plan to kick off a command and then go do something else for a
Run this command in the Fjord repository top-level directory:
It takes a while the first time you do this since it has to create the
virtual machine and provision it.
First it downloads an Ubuntu Linux 14.04 image (~300mb), then it
installs some software in this image like MySQL and
Elasticsearch. Then it sets things up so that Fjord runs in this VM
using the files on your machine. This allows you to use whatever
editor you like on your machine to edit code that runs in the VM
without having to copy files around.
After you’ve created a vm, we have some minor setup to do:
# Create a shell on the guest virtual machine
# Change into the fjord/ directory
First we download all the product detail data:
# Update product details
./manage.py update_product_details -f
Then we set up the database:
# Create the database and run migrations
Then we create a superuser to log into Fjord:
The username and password don’t matter, but the email address
does. You must choose an email address that is your Persona
identity. If you don’t have a Persona identity, you can create one at
the Persona site.
You can convert any account into a superuser account by doing:
./manage.py ihavepower <email-address>
After that, let’s generate some data in the database so that we have
something to look at. We’ll then need to index that data so it shows
up in searches.
# Generate sample data
# Index the sample data into Elasticsearch
Fjord is a Django project. We use the Django runserver to run the
website to test it.
First, if you haven’t got a running virtual machine, launch it with:
Then, ssh into the virtual machine:
This gives you a shell in the virtual machine that lets you run all
the Django commands, run the test suite, etc.
To launch the Django runserver, use the vagrant ssh shell and do:
./manage.py runserver 0.0.0.0:8000
Then on your host computer, use your browser and go to
http://127.0.0.1:8000. You should see Fjord.
Sample data is tied to a specific moment in time. You’ll need to run
the generatedata command every time you need fresh data.
The generatedata command only generates data and saves it to the
db. After running generatedata, you’ll need to add that data to the
You can call generadata as many times as you like.
|Command to run on host
|Launches the vm
|SSHs to the vm
|Halts the vm
|Status of the vm
|Destroys the vm (not recoverable!)
See more in the Vagrant documentation. If you have questions, let us know.
You can see the complete list of
./manage.py commands by typing:
For each command, you can get help by typing:
./manage.py <COMMAND> --help
We use the following ones pretty often:
||Generates fake data so Fjord works
||Runs the Django server
||Collects static files and “compiles” them
||Migrates the db with all the migrations specified in the repository
||Opens a Python REPL in the Django context for debugging
||Reindexes all the db data into Elasticsearch
||Shows the status of things in Elasticsearch
||Updates the product details with the latest information
||Turns a user account into a superuser
You can get sample data in your db by running:
This will generate 5 happy things and 5 sad things so that your Fjord
instance has something to look at.
If you want to generate a lot of random sample data, then do:
./manage.py generatedata --with=samplesize=1000
That’ll generate 1000 random responses. You can re-run that and also
pass it different amounts. It’ll generate random sample data starting
at now and working backwards.
Vagrant sets up a forward between your host machine and the guest
machine. You need to run the runserver in a way that binds to all the
Run it like this:
./manage.py runserver 0.0.0.0:8000
When you’re running the dev server (i.e.
./manage.py runserver ...),
Fjord compiles the LESS files to CSS files and serves them
individually. When you’re running Fjord in a server environment, you
to compile the LESS files to CSS files and then bundle the CSS files
and JS files into single files and minify them. This reduces the
number of HTTP requests the browser has to make to fetch all the
relevant CSS and JS files for a page. It makes our pages load faster.
However, a handful of tests depend on the bundles being built and will
fail unless you run
Over time, code changes to Fjord require changes to the
database. We create migrations that change the database from one
version to the next. Whenever there are new migrations, you’ll need to
apply them to your database so that your database version is the
version appropriate for the codebase.
To apply database migrations, do this:
For more information on the database and migrations, see Maintaining the db.
This allows you to open up a Python REPL in the context of the Django
project. Do this:
Fjord uses Elasticsearch to index all the feedback responses in a form
that’s focused on search. The front page dashboard and other parts of
the site look at the data in Elasticsearch to do what they do. Thus if
you have no data in Elasticsearch, those parts of the site won’t work.
To reindex all the data into Elasticsearch, do:
If you want to see the status of Elasticsearch configuration, indexes,
doctypes, etc, do:
Event data like Firefox releases and locale data are all located on a
server far far away. Fjord keeps a copy of the product details local
because it requires this to run.
Periodically you want to update your local copy of the data. You can do that by
If you create an account on Fjord and want to turn it into a superuser
account that can access the admin, then you need to grant that account
superuser/admin status. To do that, do:
./manage.py ihavepower <email-address>
Fjord comes with unit tests and we use py.test for running them.
Before you run the tests, make sure you run
I run this any time I run the tests with a clean database.
The test suite is run like this:
That uses the default options defined in
pytest.ini. You can
specify different command line options on the command line.
For more information about running the tests, writing tests, flags you
can pass, running specific tests and other such things, see the
We use memcached for caching. to flush the cache, do:
echo "flush_all" | nc localhost 11211
The Ubuntu image that we are using, has UTC as the configured timezone.
Due to this, if you are in a different timezone and make commits from
the VM, the commit timestamps will have a different timezone when
compared to the timezone on the host computer. To have matching
timezone on the host and the VM, run:
sudo dpkg-reconfigure tzdata
and select your current timezone as the timezone for the VM.
Fjord is in active development and periodically there are changes that
require you to do something in your development environment.
Whenever big development environment changes happen, an
announcement will be sent to the input-dev mailing list. It’ll
usually include instructions on what you should do to update your
We land commits to the
master branch of the official repository
regularly. You’ll need to update your master branch with the new
commits. You can do that like this:
$ git checkout master
$ git pull
We periodically change Django models and the changes need to be
reflected in your database tables. To update your database, do this:
Fjord will often tell you when you need to update your virtualenv
with new requirements. You’ll see something like this:
(fjordvagrant)vagrant@vagrant-ubuntu-trusty-64:~/fjord$ ./manage.py runserver 0.0.0.0:8000
There are 28 requirements that cannot be checked.
The following requirements are not satsifed:
Update your virtual environment by doing:
./peep.sh install -r requirements/requirements.txt
./peep.sh install -r requirements/compiled.txt
./peep.sh install -r requirements/dev.txt
or run with SKIP_CHECK=1 .
Follow the instructions to update them.
If you need to update your node.js dependencies. To do so simply use:
If you see a “npm ERR! notarget No valid targets found.” error while
installing the Node packages, this is due to npm-lockdown being unable to
find a package that matches the hash in
Project Conventions (git, l10n, Python, etc.) covers project conventions for Python,
Development workflow covers the general workflow for taking a bug,
working on it and submitting your changes.
Maintaining the db covers database-related things like updating your
database with new migrations, creating migrations, etc.
Maintaining ElasticSearch covers Elasticsearch-related things like maintaining
your Elasticsearch index, reindexing, getting status, deleting the
index and debugging tools.
Maintaining l10n covers how we do localization in Fjord like links
to the git repository where .po files are stored, Verbatim links,
getting localized strings, updating strings in Verbatim with new
strings, testing strings with Dennis, linting strings, creating new
Testing in Fjord covers testing in Fjord like running the tests,
various arguments you can pass to the test runner to make debugging
easier, running specific tests, writing tests, the smoketest system,
Maintaining Vendor Library covers maintaining
vendor/ and the Python
library dependencies in there.