Giter Club home page Giter Club logo

nimble's Introduction

Nimble

The cross-platform personal assistant that just works. Built with the wonderful Electron, as well as many useful libraries.

For the Xcode (Swift) build of the same name, see Nimble-Swift.

Development

Electron and gulp required to be installed on your machine (npm install -g electron-prebuilt gulp). You'll also need a Wolfram Alpha API Key.

Clone the repository, install dependencies, then run gulp.

git clone https://github.com/madebybright/Nimble.git

# cd into the directory and install dependencies
cd Nimble && npm install

Create src/js/key.json for your key.

{
  "api": "KEY"
}

Run electron in the project directory to get it up and running.

# Compiles Sass and starts (gulp && electron .)
npm start

Packaging/Bundling

If you'd like to package Nimble as an app, or bundle it as a DMG, you can use our gulp tasks.

gulp package # nimble -> .app
gulp bundle # nimble -> .app -> .dmg

If you're bundling it, make sure to package it beforehand so that the .app exists for the disk image.

Checklist

  • Fix overflow problem
  • Add Random Placeholder Query Suggestions
    • Make it fade between placeholders every few seconds or so (no animation, impossible)
  • Add search button
  • Clean up request
  • Improve file structure/skeleton
  • Right click icon to exit
    • Provide mini menu for Preferences and Exit
  • Change initial position of where Nimble loads (the x and y values) [Maybe?]
  • Add math.js support
    • Allow option for query to be processed with W|A if it's first processed with math.js
  • Add error messages
    • Style error messages (@gthn)
  • Graphing?
  • Indeterminate Loading indicator
  • Always offer a link to the Wolfram|Alpha page at the bottom
  • Un-round the top border
  • Add auto-updating (Electron provides a module built on Squirrel)

Far Future Additions

Some ideas we've been kicking around that we think might have a spot in future versions of Nimble once we've actually gotten it working.

  • Quick timezone conversions (possibly with Moment.js)

Contribution

Want to make a contribution? Fork the repo, add your changes, and submit a pull request. Any type of contributions (ideas, bug fixes, fixing typos, etc.) will be appreciated!

Special Thanks To...

  • Stephen Wolfram, for creating the wonderfully frustrating Wolfram|Alpha®
  • All of the wonderful open source software we use with Nimble, viewable in package.json
  • Lastly, we'd like to thank everyone who's supported us from day one.
    • Ethan would like to thank Lucas Steuber of LanguageCraft, Willow Bumby of Cosmic Labs, as well as the rest of the Bright team, Trevor, Logan, Aaron, and /r/webdev on Reddit.

License

LICENSE

Tag Tag Tag Tag

nimble's People

Contributors

ethel-dev 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.