2020-07-15 20:22:23 +00:00
< img src = "https://raw.githubusercontent.com/mue/branding/master/logo/logo_round.png" align = "left" width = "180px" height = "180px" / >
< img align = "left" width = "0" height = "192px" hspace = "10" / >
2020-10-17 11:57:03 +00:00
> <a href="https://muetab.com/">Mue</a>
2020-07-15 20:22:23 +00:00
[![License ](https://img.shields.io/badge/license-BSD%203-blue?style=flat-square )](/LICENSE) [![Discord ](https://img.shields.io/discord/659129207208804381?label=discord&color=7289DA&style=flat-square )](https://discord.gg/zv8C9F8) [![Code Size ]( https://img.shields.io/github/languages/code-size/mue/mue?color=green&label=size&style=flat-square )]()
< br >
2020-07-20 21:39:31 +00:00
[![Microsoft Edge ](https://img.shields.io/badge/dynamic/json?style=flat-square&label=microsoft%20edge&query=%24.version&url=https%3A%2F%2Fmicrosoftedge.microsoft.com%2Faddons%2Fgetproductdetailsbycrxid%2Faepnglgjfokepefimhbnibfjekidhmja )](https://microsoftedge.microsoft.com/addons/detail/aepnglgjfokepefimhbnibfjekidhmja) [![Firefox ](https://img.shields.io/amo/v/mue?label=firefox&style=flat-square )](https://addons.mozilla.org/firefox/addon/mue) [![Chrome ](https://img.shields.io/chrome-web-store/v/bngmbednanpcfochchhgbkookpiaiaid?label=chrome&style=flat-square )](https://chrome.google.com/webstore/detail/mue/bngmbednanpcfochchhgbkookpiaiaid)
2020-07-15 20:22:23 +00:00
2020-07-15 20:24:48 +00:00
Mue is a fast, open and free-to-use browser extension that gives a new, fresh and customizable tab page to most modern browsers
2020-07-15 20:22:23 +00:00
< br >
## Table of contents
* [Screenshot ](#screenshot )
* [Features ](#features )
* [Planned Features ](#planned-features )
* [Installation ](#installation )
* [Chrome ](#chrome )
* [Firefox ](#firefox )
2021-03-23 11:45:09 +00:00
* [Edge Chromium ](#edge-chromium )
* [Naver ](#naver )
* [Other ](#other )
2020-07-15 20:22:23 +00:00
* [Contributing ](#development )
* [Requirements ](#requirements )
2020-08-10 18:49:46 +00:00
* [Starting ](#starting )
2020-07-15 20:22:23 +00:00
* [Building ](#building )
* [Credits ](#credits )
* [Maintainers ](#maintainers )
2020-08-26 13:32:52 +00:00
* [Contributors ](#contributors )
* [Translators ](#translators )
2019-07-06 12:46:08 +00:00
2020-07-15 20:22:23 +00:00
## Screenshot
![Screenshot ](assets/screenshot.jpg )
2019-07-06 12:46:08 +00:00
## Features
* Fast and free
* Supports multiple browsers
2020-07-15 20:22:23 +00:00
* Actively developed and open source
2020-07-20 21:39:31 +00:00
* Automatically updating API (no tracking) with new photos, quotes and offline mode
2019-12-27 22:07:41 +00:00
* Search bar
2020-07-20 21:39:31 +00:00
* Settings - enable/disable various features and customise parts of Mue
* Update modal, copy button and more!
2020-08-26 13:32:52 +00:00
* Marketplace - download custom photo packs, quote packs, preset settings and themes made by the community!
2019-09-26 10:06:27 +00:00
2020-09-16 15:57:12 +00:00
### Planned Features
2020-10-16 12:15:10 +00:00
Please see our [roadmap ](https://github.com/mue/mue/projects )
2020-09-16 15:57:12 +00:00
2019-07-06 12:46:08 +00:00
## Installation
2020-10-17 11:57:03 +00:00
*A demo of the tab can be found [here ](https://demo.muetab.com )*
2019-07-06 12:46:08 +00:00
### Chrome
2019-12-01 22:00:05 +00:00
[![Chrome Web Store Logo ](assets/chrome.png )](https://chrome.google.com/webstore/detail/mue/bngmbednanpcfochchhgbkookpiaiaid)
2020-07-15 20:22:23 +00:00
< br >
[Chrome Web Store ](https://chrome.google.com/webstore/detail/mue/bngmbednanpcfochchhgbkookpiaiaid )
2019-07-06 12:46:08 +00:00
### Firefox
2019-12-01 22:00:05 +00:00
[![Firefox Add-ons Logo ](assets/firefox.png )](https://addons.mozilla.org/firefox/addon/mue)
2020-07-15 20:22:23 +00:00
< br >
[Firefox Add-ons ](https://addons.mozilla.org/firefox/addon/mue )
2019-07-06 12:46:08 +00:00
2019-12-26 12:10:39 +00:00
### Edge (Chromium)
2020-11-08 11:48:37 +00:00
~~[Microsoft Edge Addons](https://microsoftedge.microsoft.com/addons/detail/aepnglgjfokepefimhbnibfjekidhmja)~~ Currently outdated, please use the Chrome Web Store version
2020-07-15 20:22:23 +00:00
2021-03-23 11:45:09 +00:00
### Naver
[Whale Store ](https://store.whale.naver.com/detail/ecllekeilcmicbfkkiknfdddbogibbnc )
### Other
Please note that we have dropped support for Opera as of Mue 5.0
2020-07-20 21:39:31 +00:00
[GitHub Releases ](https://github.com/mue/mue/releases )
2019-07-06 12:46:08 +00:00
### Development
2020-07-15 20:22:23 +00:00
#### Requirements
2019-07-06 12:46:08 +00:00
< ol >
2020-08-26 13:32:52 +00:00
< li > < a href = 'https://git-scm.com' > Git< / a > < / li >
2020-07-15 20:22:23 +00:00
< li > < a href = 'https://nodejs.org' > Node.JS< / a > < / li >
2019-07-06 12:46:08 +00:00
< li > A suitable browser< / li >
< / ol >
< h5 > Starting< / h5 >
< ol >
2020-08-26 13:32:52 +00:00
< li > Clone the repository using < code > git clone https://github.com/mue/mue.git< / code >
< li > Run < code > yarn< / code > or < code > npm i< / code > to install all needed dependencies
< li > Run < code > yarn start< / code > or < code > npm start< / code > to start testing
2020-07-15 20:22:23 +00:00
< li > Code your heart out! (See the sections below for how to build the extension)
2019-07-06 12:46:08 +00:00
< / ol >
2020-07-20 21:39:31 +00:00
< h2 > Building< / h2 >
2019-07-06 12:46:08 +00:00
< details >
2019-12-27 22:17:27 +00:00
< summary > < b > Chrome/Edge (Chromium)< / b > (Click to expand)< / summary >
2019-07-06 12:46:08 +00:00
< ol >
2020-07-15 20:22:23 +00:00
< li > < code > yarn run build< / code > or < code > npm run build< / code >
2020-08-27 17:15:59 +00:00
< li > < code > yarn run chrome< / code > or < code > npm run chrome< / code >
2019-07-06 12:46:08 +00:00
< li > Visit < code > chrome://extensions< / code > in Chrome
< li > Click < b > Load unpacked< / b > (Make sure < b > Developer Mode< / b > is on)
2019-10-20 14:47:35 +00:00
< li > Go to the directory containing the built copy of Mue and click < b > ok< / b >
2019-07-06 12:46:08 +00:00
< li > Enjoy your new tab!
2020-10-28 17:02:01 +00:00
< / ol >
2019-07-06 12:46:08 +00:00
< / details >
< details >
< summary > < b > Opera< / b > (Click to expand)< / summary >
< ol >
2020-07-15 20:22:23 +00:00
< li > < code > yarn run build< / code > or < code > npm run build< / code >
2020-08-27 17:15:59 +00:00
< li > < code > yarn run opera< / code > or < code > npm run opera< / code >
2019-07-06 12:46:08 +00:00
< li > Visit < code > about://extensions< / code > in Opera
< li > Click < b > Load unpacked extension...< / b > (Make sure < b > Developer Mode< / b > is on)
< li > Go to the directory containing Mue and click < b > ok< / b >
< li > Enjoy your new tab!
2020-10-28 17:02:01 +00:00
< / ol >
2019-07-06 12:46:08 +00:00
< / details >
< details >
< summary > < b > Firefox< / b > (Click to expand)< / summary >
< ol >
2020-07-15 20:22:23 +00:00
< li > < code > yarn run build< / code > or < code > npm run build< / code >
2020-08-27 17:15:59 +00:00
< li > < code > yarn run firefox< / code > or < code > npm run firefox< / code >
2019-07-06 12:46:08 +00:00
< li > Visit < code > about:debugging#addons< / code > in Firefox
< li > Click < b > Load Temporary Add-on< / b >
< li > Go to the directory containing Mue and click on the < b > manifest.json< / b >
< li > Enjoy your new tab!
< / ol >
< / details >
< details >
< summary > < b > Other< / b > (Click to expand)< / summary >
< i > Note: To get the full new tab experience, set your browser to open the < code > index.html< / code > on startup and tab open!< / i >
2020-10-28 17:02:01 +00:00
< ol >
< li > < code > yarn run build< / code > or < code > npm run build< / code >
< li > Open the < code > index.html< / code > in your browser
< li > Enjoy your new tab!
< / ol >
2019-07-06 12:46:08 +00:00
< / details >
## Credits
2020-10-28 17:02:01 +00:00
### Core Team
#### Developers
2021-02-27 23:51:13 +00:00
[David Ralph ](https://github.com/davidjcralph ) - Lead development, photographer < br >
2020-11-08 11:48:37 +00:00
[Alex Sparkes ](https://github.com/alexsparkes ) - Name, lead design, photographer < br >
2020-10-28 17:02:01 +00:00
2021-02-27 23:51:13 +00:00
[Isaac Saunders ](https://github.com/eartharoid ) - QA, development, photographer < br >
2020-11-08 11:48:37 +00:00
[Wessel Tip ](https://github.com/Wessel ) - Development < br >
2020-08-26 13:32:52 +00:00
### Translators
2020-10-11 15:54:07 +00:00
[Wessel Tip ](https://github.com/Wessel ) - Dutch
2020-08-26 14:45:02 +00:00
2020-10-15 14:50:03 +00:00
[Alex Sparkes ](https://github.com/alexsparkes ), [Maxime ](https://github.com/exiam ) - French
2020-08-26 14:45:02 +00:00
2020-10-11 15:54:07 +00:00
[Anders ](https://github.com/FuryingFox ) - Norwegian
2020-08-26 14:45:02 +00:00
2020-10-15 14:50:03 +00:00
[Pronin Egor ](https://github.com/MrZillaGold ) - Russian
2019-07-06 12:46:08 +00:00
2020-10-28 17:02:01 +00:00
[Vicente ](https://github.com/Vicente015 ) - Spanish
2021-03-23 16:38:27 +00:00
[Austin Huang ](https://github.com/austinhuang0131 ) - Chinese (Simplified)
2021-03-26 20:22:20 +00:00
[FreeFun ](https://github.com/xXFreeFunXx ) - Germany
2020-10-28 17:02:01 +00:00
### Resources
2019-09-26 10:06:27 +00:00
[Pexels ](https://pexels.com ) - Stock photos used for offline mode
2020-08-26 14:45:02 +00:00
2020-08-26 13:32:52 +00:00
[Opera Forum ](https://forums.opera.com/topic/25046/how-to-disable-completely-the-speed-dial/14 ) - Portions of code to add Opera support
2020-08-26 14:45:02 +00:00
2020-10-28 17:02:01 +00:00
Many thanks to [Highholding ](https://discord.bio/p/highholding ), [Noa Shapira ](# ), [Roee Lupo ](https://github.com/RoeeLupo ), [Jeroen ](# ), [Glasvegas ](https://twitter.com/_glasvegas ), [Anders ](https://github.com/FuryingFox ), [Oded Shapira ](https://twitter.com/dondishdev ), Jacob Tyrrell and [Nikka Lai ](# ) for letting us use their wonderful photographs.
2021-03-17 13:01:53 +00:00
And finally, a big thank you to all the [contributors ](https://github.com/mue/mue/graphs/contributors )!