# Bitcoin Trade Guard

Important notice

This app is in an early development stage and not ready for production yet.

Introduction

If you are trading with Bitcoin, it's important to have overview of all your trades. That way you can analyse your trading strategy, check how much you profit or lose and make further decisions.

This app provides numerous features which help you with your trading activity:

Manage all your trades
Synchronize trades from popular Bitcoin exchanges
Analyze your activity with key figures and charts
Check the stats at historical moments
Keep your data local or save it to the cloud

Build

In order to build the web app, you need to ensure that you have git, nodejs and its package manager npm installed on your system. With these requirements fulfilled, you can build from shell by following this example:

# Get the project
git clone https://github.com/davidknezic/bitcoin-trade-guard.git

# Change into project folder
cd bitcoin-trade-guard/

# Install grunt & bower globally, so we can use their cli commands
npm install -g grunt-cli bower

# Install project dependencies used for building
npm install

# Install project dependencies used on client side
bower install

# Optional: Run the tests
grunt test

# Build the project
grunt build

The built web app is placed into the newly created build folder, located in the project root. You can take these files and let them beeing served by any web server.

Setup

There is a lightweight productive server bundled with this app. You can find it in the bin folder. To run the web app you just have to complete all previously explained build steps and run the server:

./bin/server ./build/

Since the next thing to do is – in most cases – to reverse proxy the web app, you can configure the port and address which the server binds to. Just check out the possibilities by invoking the server with the help option:

./bin/server -h

As soon as you successfully run the server, you can open the app using your favorite web browser and start managing your trades!

Contributing

Help is always welcome! Contribute to the project by forking and submitting a pull request.