Skip to content

Cryptobase is a crypto trading platform used for buying and selling of crypto assests.

License

Notifications You must be signed in to change notification settings

jamesoyanna/cryptobase-dashboard

Repository files navigation

Cryptobase application

About Project

Cryptobase is a crypto trading platform used for buying and selling of crypto assests.

Application Features

-Dashboard for display of Total and availbale crypto coins. -Signup and Login authentication system.

-Page for the display and description of crypto currencies such as Bitcoin, Ethereum, LiteCoin, Binance Coin etc.

  • A piechart showing the various amount of the crypto currency assets you have in pictorial view.
  • Tradingview widget, a powerful chart for the display of realtime crypto currency trading activity.
  • Buy Button for the purchase of crypto currency.
  • Sell Button for the sale of crypto currency
  • Portfolio section for the display of the amount of crypto currency asset you have in your wallet.

Application Functionalities

  • Buy default the application credits your wallet with up 1000 dollars to trade with.

To purchase a crypto currency asset, select any of the available crypto currencies displayed on your dashboard.

-View the value of the current price of the crypto coin in dollars.

-Input the value of the crypto you want to buy in dollars in the input form.

The system will authomatically calculate the value of crypto asset then click on the buy button

-If your transaction is successful, this will display a modal with a message "Successful purchase" and the value of the crypto coin you purchased.

To Sell a crypto coin, select the particular crypto coin you want to sell.

Check also the amount of the particular crypto coin you have.

Input the amount you want to selll in the input box and click on the sell button.

-If your transaction is successful, this will display a modal with a message "Successful Sale" and the value of the crypto coin you sold.

The total value of your crypto asset will be recalculated and displayed on your dashboard.

Login Credentials:

Username: admin
Password: admin123

Live view of the application Demo can be found here- Cryptobase application

Pictorial View of the Application

Home page

landing-page

Login Section:

login

Dashboard Display: dashboard

Crypto Currency Trading View: Trading-View

Purchase of Bitcoin: Purchase-bitcoin

How to use the application

Table of Contents

Getting Started

Dependencies

Client Side

The project is built with;

  • React JS -Library for building user interfaces.
  • React Bootstrap - A component-based library that provides native Bootstrap components as pure React components
  • Axios - Promise based HTTP client for the browser and node.js
  • Redux - A Predictable State Container for JavaScript Applications.
  • Redux-Thunk - A middleware that lets you call action creators that return a function instead of an action object.
  • React-router - Enables the to implementation of dynamic routing in a web app.
  • React Tradeview Widget -React component for rendering the TradingView Advanced Real-Time Chart Widget.
Server Side
  • Express JS - flexible Node.js web application framework that provides a robust set of features for web and mobile applications.

  • Bcrypt JS - This module enables storing of passwords as hashed passwords instead of plaintext.

  • Mongoose - Provides a straight-forward, schema-based solution to model application data.

  • Node.js- Cross-platform, back-end JavaScript runtime environment that runs on the V8 engine and executes JavaScript code outside a web browser.

  • dotenv- dotenv allows you to separate secrets from your source code.

Database
  • MongoDB- As a document database, MongoDB makes it easy for developers to store structured or unstructured data

Prerequisites

Ensure you have NodeJS installed by entering node -v on your terminal If you don't have NodeJS installed, go to the NodeJS Website, and follow the download instructions

Tools Required

The following tools are required to run this application:

  • A text editor like Visual Studio Code
  • Command Line

Getting the source code

You can clone the repository directly using this command: git clone https://github.com/jamesoyanna/cryptobase-dashboard.git OR clicking on the code button ontop to clone the application.

Installation

Installation steps:

Node.js and Yarn or Npm Your computer must have installed nodejs, and yarn to run this application You can download Node.js from https://nodejs.org and yarn from https://yarnpkg.com/lang/en/docs/install/ . NPM comes bundled with Node.js

nodejs

Install Npm Packages

After clonning the application, to run the frontend application locally, you will have to install all the dependencies and packages. Open your terminal and navigate into the frontend folder using the command: cd frontend

Run yarn or npm install from the root of the frontend folder.

Running the frontend App

Run yarn start or npm start from the root of the frontend folder to start the development server. 
Go to http://localhost:3000 on your browser. Your app should be running.
The app will automatically reload if you make changes to any of the source files.

Running the Server

Open the project folder you cloned. Create a .env file in the root folder Fill in the following credentials: PORT= MONGODB_URL= SECRET= EXPIRES_IN=

Run npm install from your terminal. Then run npm start. Your server should start running on port 5000.

Author

James Oyanna