Code Monkey home page Code Monkey logo

todometer's Introduction

todometer

A simple, meter-based to-do list built with Electron and React.

todometer

Download

Nab the latest version from the Releases page!

Development

  • Clone the repo:
$ git clone https://github.com/cassidoo/todometer.git
  • Go to the project directory and install dependencies:
$ cd todometer && npm install

To show the Electron application window with your current build:

$ npm run dev

To build a production version:

$ npm install
$ npm run postinstall
$ npm run pre-electron-pack
$ npm run electron-pack

Contributing

So you want to contribute? Yay! Great! Fun! I love seeing new PRs for todometer. That being said, not every pull request will be merged. The general guidelines I'll follow are:

  • Does it make developing todometer easier?
  • Does it help other platforms (Windows, Mac, Linux) work better?
  • Does it fix a bug?
  • Does it break anything?
  • Does it stick to the original goal of todometer (a simple, meter-based to-do list)
  • Does it reduce the build size?
  • Is it necessary?

Regarding that last point, I don't expect all pull requests to be absolutely necessary. New features are good. That being said, if the new features make the app unnecessarily complex in some way without bringing value to the users, it won't be merged.

Please don't be hurt if your PR isn't merged. You're lovely for working on it. If you are thinking about working on something, feel free to make an issue beforehand so that you can make sure it'll be worth your time!

todometer's People

Contributors

cassidoo avatar nickymeuleman avatar farskid avatar the-jonsey avatar jamtur01 avatar janosorcsik avatar palashkaria avatar dependabot[bot] avatar contendaclara avatar lxvc avatar thomasvaeth 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.