Bonjourr

<h1 align="center"> <a href="https://bonjourr.fr"> <img src="https://raw.githubusercontent.com/victrme/Bonjourr/master/src/assets/bonjourr.png" width="50%" alt="Bonjourr's website"> </a> </h1>

Bonjourr is a home page for your Internet browser inspired by the looks of iOS.<br> 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
• ⏱️ Pomodoro
• 👋 Greets you by your name
• 🌘 Dark mode
• 🥖 Emoji as favicon
• 🧑‍💻 Custom CSS styling
• 📝 Custom fonts
• 🔒 Privacy focused & no generative AI
• 🌎 Multilanguage

<br>

🚀 Install Bonjourr!

<img src="https://labels.tahoe.be/chrome_download_dark.svg" height="53" alt="Download Bonjourr for Chrome"> <img src="https://labels.tahoe.be/firefox_download_dark.svg" height="53" alt="Download Bonjourr for Firefox"> <img src="https://labels.tahoe.be/edge_download_dark.svg" height="53" alt="Download Bonjourr for Edge"> <img src="https://labels.tahoe.be/safari_download_dark.svg" height="53" alt="Download Bonjourr for Safari">

You can also try it online 🌎 before installing.

<br>

👋 Get in touch

Follow us on Bluesky or check out our Telegram group where we discuss ideas, features and bug reports. You can also send us an email :)

<br>

✍️ 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 or custom profiles
• Translate to a new language, or complete an existing one
• Contribute to our website
• Add new quotes (especially non english/french) to the API
• Suggest new Unsplash photos

<br>

🌟 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 or Twitter)
• Leave a review on Chrome, Firefox or Edge
• Add a GitHub Star to the repository ⭐️

<br>

☕ 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 for the entire month after you donate!

<div>

Our Ko-Fi Page • or donate in crypto

</div> <br>

🔧 Built with

• No frameworks, plain Typescript & CSS
• Only small dependencies, more on npmgraph
• Our tiny hands 🙌

<br>

👀 Authors

• Tahoe Beetschen · portfolio · GitHub
• Victor Azevedo · portfolio · GitHub

<br>

🧑‍💻 Contributors and translations

• 🇸🇪 Swedish translation · Benjamin Horn · GitHub
• 🇳🇱 Dutch translation · Osman Temiz
• 🇵🇱 Polish translation · Mateusz K & Jakub Mikuło
• 🇷🇺 Russian translation · OemDef
• 🇨🇳 Simplified Chinese translation · Shuhuai Cao · GitHub
• 🇧🇷 Brazilian Portuguese translation · Adilson Santos · Github
• 🇸🇰 Slovak translation · Tomáš Švec · Github & Roman Bartík
• 🇨🇿 Czech translation · Daniel Zima · Github
• 🇩🇪 German translation · Bernhard Wittmann · GitHub
• 🇮🇹 Italian translation · Trazalca · GitHub
• 🇪🇸 Spanish translation · José Alberto & Alí Sinisterra
• 🇷🇴 Romanian translation · UnifeGi & Astra
• 🇺🇦 Ukrainian translation · Anton Boksha · GitHub
• 🇹🇷 Turkish translation · Müslüm Barış Korkmazer · GitHub
• 🇮🇩 Indonesian translation · Imam Ali Mustofa · GitHub
• 🇩🇰 Danish translation · kar1 · GitHub
• 🇫🇮 Finnish translation · jaajko · Jaajko · GitHub
• 🇭🇺 Hungarian translation · cook3r · GitHub
• 🇷🇸 Serbian translation · stormigy · GitHub
• 🇭🇰 Traditional Chinese translation · Pu · GitHub
• 🇬🇷 Modern Greek translation · tseli0s · trlef19
• 🇮🇷 Farsi translation · ar3h1d · Github
• 🇵🇹 European Portuguese translation · harkadya & BlackSpirits
• 🇯🇵 Japanese translation · Kou365 & 石原英里華 (IshiharaErika)
• 🇭🇷 Croatian translation · Ghost
• 🇦🇿 Azerbaijani translation · Hacıağa Sadıxov · GitHub
• 🇧🇾 Belarusian translation · Eduard Račkoŭski · GitHub
• 🇰🇷 Korean translation · Kim JeongHyeon · GitHub

👨‍💻 Running 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.

Run locally

• Install Deno runtime: https://docs.deno.com/runtime/
• Optionally add Deno extension for VSCode or Zed
• Or a Prettier extension for VSCode
• Clone this repository
• Install dependencies
• Build Bonjourr

# In root directory
deno install

# These commands watch changes for each platforms
deno task chrome
deno task edge
deno task firefox
deno task safari
deno task 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

Online (web version)

• A live server opens with deno task online
• Go to http://0.0.0.0:8000/

Using Docker

Prerequisites:

• Docker

Docker CLI

# Build the container image
docker build -t bonjourr/bonjourr . -f docker/app/Dockerfile

docker run --rm -p "8000:80/tcp" -it bonjourr/bonjourr

# Build using docker compose
docker compose up -f docker/compose.app.yaml -d

Go to http://0.0.0.0:8000/

Docker Desktop

• Install Docker Desktop
• Search for bonjourr/bonjourr Hub image
• Run a new container with 8000 as host port
• Go to http://0.0.0.0:8000/

🌍 Publish Bonjourr

To upload a build to Firefox addons, chrome web store, edge addons, you need to create an archive. Docker is needed to ensure Bonjourr is always built the same way across different devices.

• Start Docker
• Run docker compose docker compose up -f docker/compose.archive.yaml --build or deno task archive
• Archives are located in "release/<platform>"

# Or "deno task archive"
docker compose -f docker/compose.archive.yaml up --build

# archive-1  | Task build deno run --allow-all ./tasks/build.ts
# archive-1  | chrome built in: 129ms
# archive-1  | Archiving chrome...
# ...