guillem-gelabert / collab-backend-1 Goto Github PK

A Bitcoin shared wallet app, designed to rapidly agree and execute group expenses through unanimous voting.

Previous installation of redis, mysql and rabbitmq is required. Install them with brew and run them one by one with command 'brew services start ______'

1. Clone the repo

$ git clone https://github.com/rogerknl/collab-backend.git
$ cd collab-backend

2. Install dependencies

$ npm install

3. Set all environment variables in .env ( look .env.example )
4. Set all parameters of db in /config/config.json
5. Generate all content of the DB

$ npm run migrate

6. Start backend development server

$ npm run dev

7. Start queue consumer's process

$ cd queue
$ node index.js

First, you’ll need to create a new account providing username, password and the Bitcoin public key of your wallet. Once you’ve validated your email address and logged in you’ll be able to: a) create new shared wallets and add other users to join it, and b) get invited to previously existing wallets.

Pick a name describing the purpose of it, and Collab will create a new Bitcoin wallet with an exclusive public key. Now you’ll be able to invite other users to be part of your Collab wallet.

You make a proposal (i.e. spend 0.05 Bitcoins on renting a terrace for Richard’s birthday party) and an e-mail will be sent to all participants of your wallet. When all of them have voted, if the decision is unanimously positive, the action gets executed and the money gets wired to the beneficiary’s account.

If a single user of the wallet votes NO to a particular proposal, the operation won’t proceed and it will get discarded. Everyone involved will receive an e-mail notifying them that the operation has been canceled. Also, a log will be created for consultation purposes.

Not necessarily, you can transfer the money directly to another third party by introducing its wallet public key.

Once inside a wallet of yours, a list with the current members will be displayed.

All the members of a particular wallet have equal voting rights. No one will be able to execute an action, withdraw funds or add another user without the consent of the rest.

Any member of a particular wallet can invite another user to join in, but it needs approval of the rest of the existing members. The process will be the same as with the vote on a new transaction: a new email notification asking if you want that new user added, and, should everyone agree, that user will now be a full member of the wallet with the same privileges as the rest.

With the public key anyone is able to make inbound transactions to any wallet.

Yes, you could have a myriad of different wallets depending on the purpose (putting together a specific event happening a set date -a neighbourhood BBQ- or a continuous collaboration -a rehearsal space with a few other musicians-) or the people involved (friends, colleagues, family).

You’ll be able to consult in real time the current balance of every wallet, along with its history through time.

Besides an email notification asking you to vote on everytime a new operation gets proposed, you be able to check your pending ones for every wallet inside the app.

• KOA - Framework for node js
• Redis - ElasticCache
• MySQL - DataBase
• RabbitMQ - Open Source Message Broker
• Bitcore - Api for manage bitcoins
• Nodemailer - Module for nodejs to allow easy as cake email sending
• Bcrypt - Library to help you hash passwords

Any contribution is welcome, just fork the repository and do your thing. Then submit a pull request pointing to this repo.

• Doruk Akpek - GitHub LinkedIn

• Roger Canela - GitHub LinkedIn

• Xavi Guasch - GitHub LinkedIn

• Carlos Parera - GitHub LinkedIn

• Jon Portella - GitHub LinkedIn

This project is licensed under the MIT License.