Files
mue/README.md
David Ralph 85a3ce0769 AM/PM hotfix
2019-12-26 12:10:39 +00:00

5.5 KiB

Logo

Mue

Discord Badge

Fast, open and free-to-use new tab page for most modern browsers.

Features

  • Fast and free
  • Supports multiple browsers
  • Actively developed and opensource
  • Automatically updating API (with no tracking!) with new photos, quotes and offline mode
  • Multiple language support
  • Settings feature - enable/disable features!
  • Search bar, update modal, copy button and more!

Mue has been recently rewritten with React and is missing the features that are crossed out

Installation

Note: A demo of the tab can be found here.

Chrome

Chrome Web Store Logo

Link: Chrome Web Store

Development: Read the Development section.

Firefox

Firefox Add-ons Logo

Link: Firefox Add-ons

Development: Read the Development section.

Edge (Chromium)

Link: Microsoft Edge Addons

Opera/Other

Link: GitHub Releases

Development/Other: Read the Development section.

Development

Requirements
  1. Git (optional)
  2. Node.js
  3. A suitable browser
Starting
  1. git clone https://github.com/muetab/mue (If you don't have Git just go to Clone or download and click Download ZIP)
  2. Open a terminal and run these commands: (in the Mue directory)
  3. yarn (or npm i)
  4. yarn start (or npm start)
  5. Start developing! (See the sections below for how to build the extension)

Building

Chrome (Click to expand)
  1. yarn run build (or npm run build)
  2. Rename manifest-chrome.json in the "manfiest" folder to manifest.json in "build"
  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!
Opera (Click to expand)
  1. yarn run build (or npm run build)
  2. Rename manifest-opera.json in the "manfiest" folder to manifest.json in "build"
  3. Copy in the "manifest" folder to "build"
  4. Visit about://extensions in Opera
  5. Click Load unpacked extension... (Make sure Developer Mode is on)
  6. Go to the directory containing Mue and click ok
  7. Enjoy your new tab!
Firefox (Click to expand)
  1. yarn run build (or npm run build)
  2. Rename manifest-firefox.json in the "manfiest" folder to manifest.json in "build"
  3. Move manifest/background-opera.js to build/background-opera.js
  4. Visit about:debugging#addons in Firefox
  5. Click Load Temporary Add-on
  6. Go to the directory containing Mue and click on the manifest.json
  7. 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!

Screenshot

Will be updated if needed

Screenshot

Credits

Maintainers

ohlookitsderpy (lead dev)

TurboMarshmello (name idea, code contributions)

Other

Pexels - Stock photos used for offline mode

Opera Forum - Portions of code to add Opera support

Google Fonts - Lexend Deca font

Translations

ohlookitsderpy - English (Quotes and Messages)

Yanderella - Italian (Quotes and Messages)

Pepehound - Spanish (Quotes and Messages)

Candystick - Portuguese (Some Quotes)

PassTheWessel - Dutch (Messages)

Yanderella and ohlookitsderpy - French (Messages)

untocodes - Finnish and German (Messages)

dondish - Hebrew and Russian (Messages)

Roee Lupo (MrSheldon) - Arabic and Swedish (Messages)

Feel free to pull request with other translations!

and all the contributors <3

License

BSD-3-Clause