Skip to content

Latest commit

 

History

History
74 lines (53 loc) · 3.69 KB

README.md

File metadata and controls

74 lines (53 loc) · 3.69 KB

ViceRoy

ViceRoy is a web application built to help people make more informed decisions when buying and selling cryptocurrencies via a mock exchange.

Table of Contents

Description

ViceRoy is a web application that provides users with cryptocurrency market analysis and crypto data. It helps people make more informed decisions when buying and selling crypto. ViceRoy was built using React, Figma, Firebase, Node.js, Vite, Material UI, and ES6.

Technologies Used

React Figma Firebase Node.js Javascript Material UI Vite

Installation

Clone the repository and install the dependencies:

git clone https://github.com/BleachedBlueOcean/ViceRoy.git
cd ViceRoy
npm install

Run the application:

npm run dev

Sample .env File

VITE_API_KEY=<your_vite_api_key>
VITE_AUTH_DOMAIN= <your_firebase_auth_domain>
VITE_PROJECT_ID=<your_fire_project_id>
VITE_STORAGE_BUCKET=<your_firebase_storage_bucket>
VITE_MESSAGING_SENDERID=<your_firebase_messaging_sender_id>
VITE_APP_ID=<your_firebase_app_id>
VITE_MEASUREMENT_ID=<your_firebase_measurement_id>
VITE_NEWS_API=<your_cryptocurrency_news_api_key>

Authors and Contributors

Wins and Improvements

One of the biggest wins with this project was the ability to quickly build a web application that allowed users to make informed decisions when buying and selling cryptocurrencies. We were able to use React, Figma, Firebase, Node.js, Vite, Material UI, and ES6 to build an application that was both functional and aesthetically pleasing while also able to stream live market data and news.

Some areas that could be improved upon include the speed of the application. There were times when the application was slow to load or slow to respond. Additionally, we could improve the user experience by adding more features and including a quick tutorial on site usage via text bubbles. As a stretch goal to be more inline with current exchange web apps, implementing options, short-sell, and various other market equity options.