Mozilla Pulse

Pulse is a platform that helps the Mozilla Network capture and broadcast its projects and activities. mozillapulse.org

Around the globe, teachers, engineers, activists, and others collaborate to protect and extend the internet as a public resource. They create amazing apps, art, tools, games, and campaigns. Their impact is tremendous, but decentralized and difficult to track, even within the network.

Pulse reveals the network's footprint, it fosters collaboration and amplifies the big wins.

Contribute

Testing

Interested in contributing to this project? A good place to start is by helping with Quality Tests. File a new issue to say hello and let us know that you're interested.

Fix bugs or help with new features

Browse the issues. Look for the labels enhancement, help wanted, good first issue.

Development

Requirements

• node
• npm

Setup

$> git clone https://github.com/mozilla/network-pulse.git
$> cd network-pulse
$> npm install

If you would like to override default environment variables... create a .env file on the root directory and set your env vars there. See environment variables section for details.

Key scripts to run

npm start

This starts server in development mode. See environment variables section for PORT number.

npm test

This starts a few test scripts. Don't forget to run this command and fix errors (if any) before you git push your changes.

npm optimize

This starts a few image optimization scripts.

Environment variables

Name	Description
PORT	Default: process.env.PORT(falls back to 3000 if process.env.PORT cannot be found) The port number you are running the server on.
PULSE_API	Default: https://pulse-api.mofostaging.net/api/pulse URL to Pulse API. e.g., http://test.example.com:8000/api/pulse. To set up a local instance of Pulse API, follow instructions on Pulse API README doc.
PULSE_LOGIN_URL	Default: https://pulse-api.mofostaging.net/accounts/login/ URL to use to login to Pulse. This needs to be a Pulse API login url.
PULSE_LOGOUT_URL	Default: https://pulse-api.mofostaging.net/accounts/logout/ URL to use to logout of Pulse. This needs to be a Pulse API logout url.
PROJECT_BATCH_SIZE	Default: 24 Number of projects you want to display as a batch. Make sure this number is divisible by 2 AND 3 so rows display evenly for different screen sizes.
PROFILE_BATCH_SIZE	Default: 10 Number of profiles you want to display as a batch.
LEARN_MORE_LINK	Default: https://www.mozillapulse.org/entry/120 Link to learn more about what Pulse project is about.
NODE_ENV	Default: development When this is set to production, it enables production specific express settings and middleware
APP_HOST	Default: localhost The domain which this app should serve. It's only used when NODE_ENV is set to production

Deployment

Staging

URL: https://network-pulse-staging.herokuapp.com/

Updates to master branch automatically triggers staging deployment.

Production

URL: https://mozillapulse.org

Deployment is done using the Heroku pipeline. Simply click "Promote To Production".