Giter VIP home page Giter VIP logo

activity-stream's Introduction

Activity Stream Add-on

Coverage Status

This is the source code for the Activity Stream project, which replaces the "New Tab" of Firefox with a new design based on rich metadata and browsing behavior.

Installing

To install the release version of the add-on, check out Test Pilot.

If you would like to see changes more regularly, you can install the dev build, which is updated on every commit.

For Localizers

If you would like to help localize this project, check out out project on Pontoon.

For Developers

TLDR; I just want to run it

  1. Make sure you have Firefox Beta, node 5.0+ and at npm 3.0+ installed.
  2. npm install
  3. npm run once

Requirements

  • You must have at Firefox (45.0+) installed
  • node 5.0+, npm 3.0+ (You can install both here)

Installation

  • install from pre-builts

  • install from source

    git clone https://github.com/mozilla/activity-stream.git
    cd activity-stream
    npm install
    npm run package

Configuration

Default configuration is in config.default.yml. Create a file called config.yml to override any default configuration.

Running tasks

You may run npm run help to see a description of all commands available, which you can run via npm run [command]. Here are some important ones:

Running the add-on

If you just want to build assets and run the add-on to test it, you may simply run:

npm run once

Developing the add-on

If you want to watch assets and compile them continuously, you will want to run

npm run start

in one terminal session, and

npm run firefox

to start the add-on. This way, when you make changes to the content-src folder, they will be reflected immediately without needing to restart the add-on.

Running Tests

Run npm test to run the tests once. Run npm run help for more options.

Running benchmarks

Run npm run benchmark to run the benchmarks once. See more details for benchmarking the add-on here.

Exporting to mozilla-central

To export the bootstrapped add-on to a mozilla-central directory that shares the same parent as this current directory, run this command:

npm run buildmc

This will first clear out any existing files from mozilla-central/browser/extensions/activity-stream before copying over the newly built files and optionally patching mozilla-central/browser/extensions/moz.build to get the add-on built with Firefox. These changes to mozilla-central are uncommitted and ready for building/testing/committing.

Note: You can create a symlink to the mozilla-central repository, e.g.,

ln -s ~/other-located-or-named-mozilla-central ../mozilla-central

activity-stream's People

Contributors

adamhillier avatar alex avatar armenzg avatar bryanbell avatar csadilek avatar da2x avatar dmose avatar flodolo avatar gasolin avatar glogiotatidis avatar greenkeeperio-bot avatar jaredlockhart avatar k88hudson avatar lbelchr avatar mardak avatar mzhilyaev avatar nchapman avatar ncloudioj avatar oyiptong avatar patrickkang avatar pdehaan avatar piatra avatar rittme avatar rlr avatar sarracini avatar standard8 avatar tda avatar tspurway avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.