Trading-Manager

Simple Responsive Desktop Application written in Github's Electron/HTML/CSS/JavaScript and a in-memory database NeDb (instance of mongoDb)

Idea

I was approached by one of the crypocurrency trader to build them a app which,

Works as a windows application
Works without internet/not on any server
Has in-memory persistent database storage
Has good user interface
Functionally able to do CRUD operations with an autocomplete and ratings feature

I took this opportunity to dig into Github's Electron which I always wanted to experience on a fancy occassion as this.

Preview

Challenges

At first,everything seemed very exciting.I was overwheelmed by the idea of using HTML/CSS to write a windows desktop application.Setting up the project was easy as well.However lack of proper documentation and outdated tutorials on the web of the API made process much more complicated.Most of the methods I found in those tutorials had already changed in the version I was using hence I had to do all the research from scratch.I hope there isn't massive changes in the Electron's API compared to the version used in this app.I deployed the application at my client's side using React.js and other advanced tools but to keep things simple I've used Jquery for the demo.

Stack Contains

Configuration

Install Electron (I have not included it as dev-dependency for version conflicts and your preferred settings)

Install as a development dependency

npm install electron --save-dev
Install the electron command globally in your $PATH

npm install electron -g
Install App

Clone the repository and run

npm install
Start the application

npm start
To run the build (.exe)/Zip for distribution

electron-packager <location of project> <name of project> <platform> <architecture> <electron version> <optional options> (electron-packager is downloaded as a dev-dependency)

Sample Build :

electron-packager ~/DesktopApp Trader Manager --all --version=1.4.13 --out=~/Desktop --overwrite (Read more about the packager here electron-packager)

General Instructions

On running npm start,the app creates two given databases clients.db & category.db which would be empty until you feed data through the app.
materialize-autocomplete gets trigerred by Backspace upon entering a character.I'm assuming a bug in the plugin but owner has not updated the repo in almost an year so I didn't bother opening a PR.
In an actual highly functional application,you could optimize the build by following intructions on the electron docs.
The javascript/jquery written in the app is let simple for easier understanding.In an actual production environment,code should be optimized using object oriented or other design patterns.

Contributions

I have tested the application on my windows 8 machine.Should you come across any issues or want to update the app with the latest electron API,feel free to raise an issue.
PR's always welcomed.

Following app barely scratches the surface of what electron can do! If you read the electron docs, you'd know the advanced features provided by their API. (If time permits,I will write a detailed tutorial on programming the application from scratch)

Technologeek/Trading-Manager-Github--Electron-2017-