Giter Club home page Giter Club logo

emoji-mart-desktop's Introduction

Emoji Mart Desktop App

An emoji picker desktop application - it serves as an example of using webview with a modern web framework. Nonetheless, it is a real and capable application, and nothing should stop you from simply using it.

Contents

Application / Usage

Linux Windows macOS

Installation

Config

Config values that are set via the in-app menu are saved for the next run.

# Lin: ~/.config/emoji-mart/
# Mac: ~/Library/Application Support/emoji-mart/
# Win: %USERPROFILE%/AppData/Roaming/emoji-mart/

# Default values
audio = true # enable audio hint on emoji-selection
frequent = true # display frequently used emojis

Webview Example / Building and Development

Preparation

# Clone the repisitory
git clone https://github.com/ttytm/emoji-mart-desktop.git
cd emoji-mart-desktop
# Install dependencies
v install --once

# If you haven't used it before, prepare the webview library.
# Linux/macOS
~/.vmodules/webview/build.vsh
# Windows PowerShell
v $HOME/.vmodules/webview/build.vsh

Building

If you just want to build the application for usage you can now run ./build.vsh.

  • The dist/ directory will contain the build output.

Building and Running in a Development Context

Since we use web technologies for the UI, a good part of the frontend-work can likely be done via the browser, just like working on a regular web application. However, there comes a point where we want to connect our V program and the UI.

Example 1 - run a vite dev server and connect to it

When connecting to a vite dev server features like hot reloading are preserved. Just like in the browser most changes on the UI will be immediately reflected in the application window.

  • Run the app with the dev flag - this runs a vite dev server and connects to its localhost instance

    # Install the node modules beforehand if it's the first run.
    npm i --prefix ui/
    v -d dev run .
    # On Windows, it is recommended to use `gcc` for compilation.
    v -cc gcc -d dev run .

Example 2 - serve the prebuilt site

This is the regular build approach and how our final app is working.

  • Build the UI - this uses SvelteKit as a static site generator

    # Install the node modules beforehand if it's the first run.
    npm i --prefix ui/
    npm run build --prefix ui/
  • Run the app - this uses vweb to serve the previously build files locally and connect to it via webview

    v run .
    # Windows
    v -cc gcc run .

I hope this quick start guide and the examples in the repositories source code help on the way to release your own UI project.

Related Projects

  • webview - V module that allows to create a system level application, while using modern web technologies for the UI.
  • LVbag - CLI tool to generate embedded file lists.

Credits

emoji-mart-desktop's People

Contributors

thomaspeissl avatar ttytm avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

thomaspeissl

emoji-mart-desktop's Issues

AppImage won't launch on EndeavourOS (Arch based distro)

I get the following when executing the latest AppImage from releases:

./emoji-mart-desktop-x86_64.AppImage 
/tmp/.mount_emoji-aCPHDV/usr/bin/emoji-mart: symbol lookup error: /usr/lib/libgio-2.0.so.0: undefined symbol: g_assertion_message_cmpint

My initial guess is that you just need to bundle libgio in the AppImage as well :)

App starting issues on macos with JS audio handling

Since moving to JS audio handling the app starts sometimes without issues, but there are a significant number of occasions where it will throw an internal server error or leave a blank window due to missing connection.

โš ๏ธ rebase after v0.2.0

The main branch of the repository underwent a rebase after the release of version v0.2.0.
I hope that while the repository is so young, not too many early cloners will be affected.
Please clone the repo again or do a rebase pull if errors occur when git updating the repo.
Sorry for the inconvenience.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.