A simple menu bar app for viewing a calendar
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Design
lib/es6/src
scripts
src
test
.gitignore
CODE_OF_CONDUCT.md
LICENSE.md
README.md
about.html
auto-updater.js
bsconfig.json
index.dev.html
index.html
index.js
package-lock.json
package.json
screenshot.png
webpack.common.js
webpack.dev.js
webpack.prod.js

README.md

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.

Code of Conduct

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.

Changelog

License