Code Monkey home page Code Monkey logo

barnacal's Introduction

Barnacal

A simple menu bar app for viewing a calendar

Screenshot of Barnacal

Installation

To install Barnacal on your system, visit the Releases page. From there you can download the binary for your system. If your system isn't supported, consider opening an issue or pull request to add support for it.

Developing

This a Node.js project at heart, so begin by installing the npm dependencies (npm 5 preferred). This may take a while if bs-platform needs to compile for your system.

npm i

You'll want to also install reason-cli, which gets your better error messages and dev tools. This project relies on it for development.

To start bsb and webpack at the same time, run npm start in a terminal window. This will automatically watch and compile changes to your reason files and hot reload them into the electron app.

npm start

Finally, open a new terminal window/tab and start the electron process. This will launch the app and you can begin using it.

# option one w/ npm 5
npx electron .

# option two
npm run start:electron

If you want the electron app to be reloaded when you edit the html or JS files, then you'll want to install watchexec first, then run the watch command.

# install watchexec if you don't have it already
brew install watchexec

npm run watch:electron

Contributing

Issues and Pull requests are both welcomed! Prettier is enabled by default as a pre-commit hook, but feel free to add it to your editor.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

barnacal's People

Contributors

mike-engel avatar

Watchers

 avatar  avatar  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.