mirror of https://github.com/mue/mue.git
browser-extensionchromechrome-extensionchromiumcustomisableedgeedge-extensionextensionfirefoxfirefox-addonhacktoberfestmodern-browsersnew-tabnewtabphotosquotesreactstartpagewebextensionwebextensions
a17ce90e07
Co-authored-by: Alex Sparkes <turbomarshmello@gmail.com> |
||
---|---|---|
.github | ||
assets | ||
manifest | ||
public | ||
src | ||
.env | ||
.gitignore | ||
CODE_OF_CONDUCT.md | ||
LICENSE | ||
README.md | ||
package.json |
README.md
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
- Contributing
- Credits
- Maintainers
- Contributors
- Other
Screenshot
May be updated in the future
Features
- Fast and free
- Supports multiple browsers
- Actively developed and open source
- Automatically updating API (no tracking) with new photos, quotes and offline mode
- Search bar
- Settings - enable/disable various features and customise parts of Mue
- Update modal, copy button and more!
Planned Features
- Multilingual support
Installation
A demo of the tab can be found here
Chrome
Firefox
Edge (Chromium)
Opera/Other
Link: GitHub Releases
Development
Requirements
Starting
- clone the repository using
git clone https://github.com/mue/mue.git
- run
yarn
ornpm i
to install all needed dependencies - run
yarn start
ornpm start
to start testing - Code your heart out! (See the sections below for how to build the extension)
Building
Chrome/Edge (Chromium) (Click to expand)
-
yarn run build
ornpm run build
- Rename
manifest-chrome.json
in the "manfiest" folder tomanifest.json
in "build" - Visit
chrome://extensions
in Chrome - Click Load unpacked (Make sure Developer Mode is on)
- Go to the directory containing the built copy of Mue and click ok
- Enjoy your new tab!
Opera (Click to expand)
-
yarn run build
ornpm run build
- Rename
manifest-opera.json
in the "manfiest" folder tomanifest.json
in "build" - Copy in the "manifest" folder to "build"
- Visit
about://extensions
in Opera - Click Load unpacked extension... (Make sure Developer Mode is on)
- Go to the directory containing Mue and click ok
- Enjoy your new tab!
Firefox (Click to expand)
-
yarn run build
ornpm run build
- Rename
manifest-firefox.json
in the "manfiest" folder tomanifest.json
in "build" - Move
manifest/background-opera.js
tobuild/background-opera.js
- Visit
about:debugging#addons
in Firefox - Click Load Temporary Add-on
- Go to the directory containing Mue and click on the manifest.json
- Enjoy your new tab!
Other (Click to expand)
Note: To get the full new tab experience, set your browser to open theindex.html
on startup and tab open!
-
yarn run build
ornpm run build
- Open the
index.html
in your browser - Enjoy your new tab!
Credits
Maintainers
ohlookitsderpy - Founder, Lead development, Photographer
TurboMarshmello - Name, Lead design, Photographer
Contributors
Wessel - Development
Isaac - QA, Development, Photographer
Chris - Development
Other
Pexels - Stock photos used for offline mode
Opera Forum - Portions of code to add Opera support
Google Fonts - Lexend Deca font
And many thanks to Highholding, Noa Shapira, Roee Lupo, Jeroen, Glasvegas, Anders, Oded Shapira and Nikka Lai for letting us use their wonderful photographs