MyCryptoPal

http://159.89.238.38/

Product Vision Statement

The goal of MyCryptoPal is to provide users an accessible gateway to the world of cryptocurrency. Cryptocurrency is an emerging type of finance that revolves around a relatively new technology called blockchain. The space is often a hot topic and is often trending on news sources, social media and financial markets. Everyone seems to have an opinion on the relatively speculative industry, but one statement that our team internalizes is the notion that cryptocurrency is too large to ignore. Rather than focus on an application that supports one opinion or another, we strive to provide an educational service that allows users to learn more about cryptocurrency, the financials behind it and the technology that it is built upon.

About Us

Shashanka Sharma

https://github.com/Shashanka-Sharma

Blake Rainey

https://github.com/brrainey13

Vish Chugani

https://github.com/vish0804

Nguyen Dang

https://github.com/nguyendang2000

Hannah Harvard

https://github.com/hh1927

Product History

A few of the team members are Crypto enthusiasts and have some experience trading cryptocurrencies in secondary markets. Our passion for the technology led to the idea of an educational platform that helps segue more individuals into the space. The crypto space is heavily run by a community effort and by introducing others into the space, we can benefit the community as a whole. A problem with the issue that is often quoted about the cryptocurrency space is it’s volatility and speculative nature. Our platform strives to provide users with a paper trading simulator of real time crypto exchanges. Users can practice trading different coins and learn more about how it’s done in a controlled and safe setting, with no potential of losing money.
See the Contributions Document

Building and Testing The Project

Initial setup

1. Clone the repository onto your local machine with git clone https://github.com/software-assignments-spring2022/final-project-mycryptopal.git
2. Navigate to the local source repository
3. Install project-wide dependencies with npm install
4. Acquire front-end .env config file and place in front-end
5. Acquire back-end .env config file and place in back-end/src

Frontend React App

1. Navigate to front-end directory
2. Install front-end dependencies with npm install
3. Launch the front-end with npm start
4. If not done automatically, access the app using a browser at localhost:3000
5. Enable Device Mode on browser (Chrome/Firefox) with Ctrl-Shift-M
6. Enter a mobile viewport size, e.g. 390 x 844, at the top of the screen to test the mobile interface of the app

Backend Express App

1. Navigate to back-end directory
2. Install back-end dependencies with npm install
3. Install nodemon globally with npm install -g nodemon
4. Launch the back-end with npm start

Testing Backend Routes

1. Navigate to the project's root folder
2. Run tests with npm test