mue/README.md

Mue

Mue is a fast, open and free-to-use browser extension that gives a new, fresh and customizable tab page to most modern browsers

Table of contents

• Screenshot
• Features
  • Planned Features
• Installation
  • Chrome
  • Firefox
  • Edge Chromium
  • Naver
  • Other
• Contributing
  • Requirements
  • Starting
  • Building
• Credits
  • Developers
  • Translators
  • Contributors
  • Resources

Screenshots

Features

• Fast and free
• Supports multiple browsers
• Actively developed and open source
• Automatically updating API (no tracking) with new photos, quotes and offline mode
• Widgets such as searchbar, weather, quick links, clock, date, quote, greeting
• Settings - enable/disable various features and customise parts of Mue
• Navbar with copy button, favourite background, notes feature etc
• Marketplace - download custom photo packs made by the community

Planned Features

Please see our roadmap

Installation

A demo of the tab can be found here

Chrome

Chrome Web Store

Firefox

Firefox Add-ons

Edge (Chromium)

Microsoft Edge Addons

Naver

Whale Store

Other

Please note that we have dropped support for Opera as of Mue 5.0

GitHub Releases

Development

Requirements

• Git
• Node.JS
• A suitable browser

Starting

1. Clone the repository using git clone https://github.com/mue/mue.git
2. Run yarn or npm i to install all needed dependencies
3. Run yarn start or npm start to start testing
4. Code your heart out! (See the sections below for how to build the extension)

Building

Chrome/Edge (Chromium) (Click to expand)

1. yarn run build or npm run build
2. yarn run chrome or npm run chrome
3. Visit chrome://extensions in Chrome
4. Click Load unpacked (Make sure Developer Mode is on)
5. Go to the directory containing the built copy of Mue and click ok
6. Enjoy your new tab!

Firefox (Click to expand)

1. yarn run build or npm run build
2. yarn run firefox or npm run firefox
3. Visit about:debugging#addons in Firefox
4. Click Load Temporary Add-on
5. Go to the directory containing Mue and click on the manifest.json
6. Enjoy your new tab!

Other (Click to expand)

Note: To get the full new tab experience, set your browser to open the index.html on startup and tab open!

1. yarn run build or npm run build
2. Open the index.html in your browser
3. Enjoy your new tab!

Credits

Developers

David Ralph - Lead development, photographer
Alex Sparkes - Name, lead design, photographer
Isaac Saunders - QA, development, photographer
Wessel Tip - Development

Translators

Wessel Tip, Heimen Stoffels - Dutch
Alex Sparkes, Maxime - French
Anders - Norwegian
Pronin Egor - Russian
Vicente - Spanish
Austin Huang - Chinese (Simplified)
FreeFun - German

Contributors

Many thanks to Highholding, Noa Shapira, Roee Lupo, Jeroen, Gio, Anders, Oded Shapira, Jacob Tyrrell and Nikka Lai for letting us use their wonderful photographs.

And finally, a big thank you to all the other contributors!

Resources

Pexels, Unsplash - Stock photos used for offline mode