/Octo-Wallet

A mock cryptocurrency network system of with user management, Bitcoin and Ethereum wallet management and transaction management.

Primary LanguageJavaScript

octo-wallet

Status GitHub Issues GitHub Pull Requests License


A mock cryptocurrency network system of with user management, Bitcoin and Ethereum wallet management and transaction management.

📝 Table of Contents

🧐 About

A mock cryptocurrency network system of with user management, Bitcoin and Ethereum wallet management and transaction management.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them.

MySQL database server
SMTP mail server

Installing

A step by step series of examples that tell you how to get a development env running.

Clone this repository

git clone https://github.com/ogunsoladebayo/octo-wallet.git

Create a file with the name '.env' and copy the contents of envcopy.env from the root directory to the new file to set up your environment variables.

cp envcopy.env .env

Fill up the fill up the file with environment variables for your environment.

Install dependencies by running the following command:

npm install

You can run the project in development environment by running the following command:

npm run dev

or in live environment

npm start

You should see the transaction processor running with the log output in the terminal.

🎈 Usage

You can find the API documentation for the application at https://documenter.getpostman.com/view/11616904/UVC8DS9v.

🚀 Deployment

This application can be readily deployed to a live system with docker.

⛏️ Built Using

✍️ Authors

🎉 Acknowledgements

  • Hat tip to anyone whose code was used
  • Inspiration
  • References