Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/victrme/bonjourr
Minimalist & lightweight startpage inspired by iOS
https://github.com/victrme/bonjourr
chrome chrome-extension firefox firefox-addon homepage ios javascript minimalist-design safari-extension startpage
Last synced: 6 days ago
JSON representation
Minimalist & lightweight startpage inspired by iOS
- Host: GitHub
- URL: https://github.com/victrme/bonjourr
- Owner: victrme
- License: gpl-3.0
- Created: 2019-05-18T10:06:45.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T05:34:07.000Z (9 months ago)
- Last Synced: 2024-04-14T02:21:19.760Z (9 months ago)
- Topics: chrome, chrome-extension, firefox, firefox-addon, homepage, ios, javascript, minimalist-design, safari-extension, startpage
- Language: TypeScript
- Homepage: https://bonjourr.fr
- Size: 48.2 MB
- Stars: 738
- Watchers: 10
- Forks: 90
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Bonjourr is a home page for your Internet browser inspired by the looks of iOS.
While it aims to look and feel minimal, it still brings you lots of options to customise it to your liking. Here's some features:
- 🍏 iOS design language
- 🏞 Dynamic 4K backgrounds that change according to the mood of the day
- ⚡️ Fast & lightweight!
- 🔎 Search bar (compatible with all search engines)
- 🕰 Analog clock with multiple clock faces
- 🌤 Weather
- 🔗 Quick Links
- 👋 Greets you by your name
- 🌘 Dark mode
- 🥖 Emoji as favicon
- 🧑💻 Custom CSS styling
- 📝 Custom fonts
- 🔒 Privacy focused
- 🌎 Multilanguage
## 🚀 Install Bonjourr!
[
](https://chrome.google.com/webstore/detail/bonjourr-%C2%B7-minimalist-lig/dlnejlppicbjfcfcedcflplfjajinajd)
[
](https://addons.mozilla.org/firefox/addon/bonjourr-startpage/)
[
](https://microsoftedge.microsoft.com/addons/detail/bonjourr-%C2%B7-minimalist-l/dehmmlejmefjphdeoagelkpaoolicmid)
[
](https://apps.apple.com/fr/app/bonjourr-startpage/id1615431236)
You can also [try it online 🌎](https://online.bonjourr.fr) before installing.
## 👋 Get in touch
Follow us [on Bluesky](https://bsky.app/profile/bonjourr.fr) or check out [our Telegram group](https://t.me/BonjourrStartpage) where we discuss ideas, features and bug reports. You can also [send us an email](mailto:[email protected]) :)
## ✍️ Contribute
Here's a list of things you can do to help us out:
- Give us feedback (positive and negative!) on how you use Bonjourr
- Suggest new features or improvements of the existing ones
- Create new [CSS snippets](https://bonjourr.fr/docs/styles) or [custom profiles](https://bonjourr.fr/docs/profiles)
- [Translate](https://bonjourr.fr/docs/contribute/#translate) to a new language, or complete an existing one
- Contribute to [our website](https://github.com/morceaudebois/bonjourr.fr)
- Add new quotes (especially non english/french) to [the API](https://github.com/victrme/i18n-quotes)
- Suggest new [Unsplash photos](https://bonjourr.fr/docs/overview/#backgrounds)
## 🌟 Spread the word!
If you just want to say thank you and support our work, here's some ideas:
- Tweet what you like about Bonjourr! (tag us, on [Bluesky](https://bsky.app/profile/bonjourr.fr) or [Twitter](https://twitter.com/BonjourrTeam/))
- Leave a review on [Chrome](https://chrome.google.com/webstore/detail/bonjourr-%C2%B7-minimalist-lig/dlnejlppicbjfcfcedcflplfjajinajd?hl=fr&authuser=0), [Firefox](https://addons.mozilla.org/fr/firefox/addon/bonjourr-startpage/) or [Edge](https://microsoftedge.microsoft.com/addons/detail/bonjourr-%C2%B7-minimalist-l/dehmmlejmefjphdeoagelkpaoolicmid)
- Add a GitHub Star to the repository ⭐️
## ☕ Donate
If you feel like we've earned it and you want to support independant open source developpers, we'll gladly accept your donations! It motivates us to keep improving Bonjourr and makes it feel more real :)
__As a token of our appreciation, donating will also get your name [featured in Bonjourr](https://bonjourr.fr/docs/overview/#supporters-notification) for the entire month after you donate!__
[Our Ko-Fi Page](https://ko-fi.com/bonjourr) •
[or donate in crypto](https://commerce.coinbase.com/checkout/095cc203-130d-4e56-9716-3aa10a202d9b)
## 🔧 Built with
- No frameworks, plain Typescript & CSS
- Only small dependencies, [more on npmgraph](https://npmgraph.js.org/?q=https://raw.githubusercontent.com/victrme/Bonjourr/master/package.json#color=outdated)
- Our tiny hands 🙌
## 👀 Authors
- **Tahoe Beetschen** · [portfolio](https://tahoe.be) · [GitHub](https://github.com/morceaudebois)
- **Victor Azevedo** · [portfolio](https://victr.me) · [GitHub](https://github.com/victrme)
## 🧑💻 Contributors and translations
- **🇸🇪 Swedish translation** · [Benjamin Horn](https://benjaminhorn.io/) · [GitHub](https://github.com/beije)
- **🇳🇱 Dutch translation** · [Osman Temiz](https://www.reddit.com/user/manllac)
- **🇵🇱 Polish translation** · [Mateusz K](https://www.reddit.com/user/DiVine92) & [Jakub Mikuło](https://github.com/jmikulo)
- **🇷🇺 Russian translation** · [OemDef](https://www.reddit.com/user/OemDef)
- **🇨🇳 Simplified Chinese translation** · Shuhuai Cao · [GitHub](https://github.com/csh980717)
- **🇧🇷 Brazilian Portuguese translation** · [Adilson Santos](http://adilsonsantos.netlify.com) · [Github](https://github.com/adilsonfsantos)
- **🇸🇰 Slovak translation** · Tomáš Švec · [Github](https://github.com/Svec-Tomas) & Roman Bartík
- **🇨🇿 Czech translation** · Daniel Zima · [Github](https://github.com/ZimaDaniel)
- **🇩🇪 German translation** · [Bernhard Wittmann](https://bernhardwittmann.com/) · [GitHub](https://github.com/berniwittmann)
- **🇮🇹 Italian translation** · Trazalca · [GitHub](https://github.com/Trazalca)
- **🇪🇸 Spanish translation** · [José Alberto](https://github.com/joatb) & [Alí Sinisterra](https://github.com/alisinisterra)
- **🇷🇴 Romanian translation** · [UnifeGi](https://github.com/UnifeGi) & [Astra](https://dry.nl.eu.org/links)
- **🇺🇦 Ukrainian translation** · [Anton Boksha](https://antonboksha.dev/) · [GitHub](https://github.com/4doge)
- **🇹🇷 Turkish translation** · Müslüm Barış Korkmazer · [GitHub](https://github.com/babico)
- **🇮🇩 Indonesian translation** · Imam Ali Mustofa · [GitHub](https://github.com/darkterminal)
- **🇩🇰 Danish translation** · kar1 · [GitHub](https://github.com/kar1)
- **🇫🇮 Finnish translation** · jaajko · [Jaajko](https://jaajko.fi) · [GitHub](https://github.com/jaajko)
- **🇭🇺 Hungarian translation** · cook3r · [GitHub](https://github.com/cook3r)
- **🇷🇸 Serbian translation** · stormigy · [GitHub](https://github.com/stormigy)
- **🇭🇰 Traditional Chinese translation** · Pu · [GitHub](https://github.com/unknownnumbers)
- **🇬🇷 Modern Greek translation** · [tseli0s](https://github.com/tseli0s) · [trlef19](https://github.com/trlef19)
- **🇮🇷 Farsi translation** · ar3h1d · [Github](https://github.com/ar3h1d)
- **🇵🇹 European Portuguese translation** · [harkadya](https://harkadya.com) & [BlackSpirits](https://github.com/Blackspirits)
- **🇯🇵 Japanese translation** · [Kou365](https://github.com/Kou365) & 石原英里華 (IshiharaErika)
- **🇭🇷 Croatian translation** · Ghost
## 👨💻 Running Bonjourr
Clone this repository
```bash
git clone https://github.com/victrme/Bonjourr
cd Bonjourr
```
### Self-host APIs
If you wish to self-host the APIs used by Bonjourr, you can do so by following the steps in [Bonjourr APIs repository](https://github.com/victrme/bonjourr-apis).
### Run locally
Prerequisites:
- [Node 18.17.20 or later](https://nodejs.org/en/download) is needed on your system to run the build script
- We recommend using [pnpm](https://pnpm.io/installation) for your convenience
You can replace `pnpm` by `npm run`
```bash
# In root directory
pnpm install
# Production build for all platforms in /release/
pnpm build
# These commands watch changes for each platforms
pnpm chrome
pnpm edge
pnpm firefox
pnpm safari
pnpm online
```
#### Chrome
- Go to `chrome://extensions`
- Enable Developer mode
- Load unpacked and select `/release/chrome` folder
#### Firefox
- Go to `about:debugging#/runtime/this-firefox`
- Select "Load temporary Add-on"
- Select `manifest.json` in `/release/firefox` folder
#### Edge
- Go to `edge://extensions`
- Enable Developer mode
- Load unpacked and select `/release/edge` folder
- Replace manifest with `/src/manifests/edge.json`
- And rename `edge.json` to `manifest.json`
#### Safari
- Follow install steps on the [Safari repository](https://github.com/victrme/Bonjourr-Safari)
#### Online (web version)
- A live server opens with `pnpm online`
- Go to http://127.0.0.1:8080/
### Using Docker
Prerequisites:
- [Docker](https://docs.docker.com/get-started)
#### Docker CLI
```bash
# Build the container image
docker build -t bonjourr/bonjourr .
# Run the container on local port 8080
docker run --rm -p "8080:80/tcp" -it bonjourr/bonjourr
# Go to http://127.0.0.1:8080/
```
#### Docker Desktop
- Install [Docker Desktop](https://www.docker.com/products/docker-desktop/)
- Search for `bonjourr/bonjourr` Hub image
- Run a new container with `8080` as host port
- Go to http://127.0.0.1:8080/