Git Product home page Git Product logo

erin's Introduction

Erin

A cross-platform app for changing wallpaper

Goal

The app was created to simplify the process of choosing and changing wallpaper

Screenshots

Dark Main Screen Light Main Screen
Dark Picker Screen Light Picker Screen
Dark Settings Screen Light Settings Screen
Dark Info Screen Light Info Screen

Installation

Download an installation file corresponding to your OS from GitHub releases

Get it from the Snap Store

Stack

Main technologies used in the project:

  • Typescript
  • React
  • Electron
  • Redux toolkit

Local setup

Setup

Copy the repository using the following command:

git clone https://github.com/losbiw/erin

Include your own .env file (or use the existing one) in the electron directory which has to contain the following variables:

  • PEXELS_API_KEY
  • WEATHER_API_KEY (OpenWeatherMap API is supported by default, in case of using another API you have to:
  • GOOGLE_API_KEY
  • GH_TOKEN (optional, but auto-updater won't work without it)

Steps to run locally

  • Install dependencies: yarn install
  • Run react app: yarn react-start
  • Transpile electron code: yarn electron-compile
  • Run electron app: yarn electron-start

Commands to build the app on each platform

  • Windows: yarn build-win
  • Linux: yarn build-linux
  • MacOS: yarn build-mac
  • All three: yarn build-mwl

erin's People

Contributors

losbiw avatar dependabot[bot] avatar

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.