Skip to content

CalArcher/top-coin

Repository files navigation

Top Coin








This project allowed me to deep-dive into the MERN stack. I focused on adhering to best practices while still striving to achieve the best performance possible. Performance was especially important with this project as the database could grow to a very large size. My initial intention was to spend about 100 hours building this fullstack app, however once I actually began the process of doing so, I discovered more and more features I wanted to implement. Some of these features included the ability to sort coins by different categories and light/dark mode toggle that would save the user’s preference to local storage.

In the end, this project took well over 200 hours from start to finish. The experience presented me with many opportunities to improve my skills and ultimately left me with a better understanding of MongoDB, Express, React, and Node.

Table of contents


Overview

Top Coin is a cryptocurrency tracker. At the end of every day (11:59pm MST), the top 10 performing coins – based on their percent growth in the last 24 hours – are added to the database. If one of these top-performing coins hasn't been in the top 10 before, a new document is created for that coin. If the coin has been in the top 10 coins previously, the coin's relevant data is updated.


Features

  • Variety of sorting options including ascending or descending order based on 24h change, 7d change, or by price.
  • Site-wide dark and light mode.
  • Site path /api/coindata route will show all historical collected data in the database.
  • Each Top 10 Coin displays a chart with data points that depict all previous dates wherein that coin was among the top 10 coins of the day.
  • Dynamic routing; each coin has its own unique route.

My process

Step 1: Planning

  • The first step of my process was finding a project that would align with my goals - to build a website with a lot of dynamic data and get some repetition for my React skills.
  • Cryptocurrency sites, like CoinMarketCap and CoinGecko are great examples of websites that display a lot of dynamic data, so I modeled my idea after their sites. I did not want to make a copy that only displays data; I wanted there to be a separate purpose, which is why I came up with the idea to only log the top 10 performing coins of the day.

Step 2: Server setup:

  • I began building the backend of the app, designing my own API for the project, and building its endpoints. With a custom API, I would have all the data I needed ready to use when building the frontend.
  • I set up a simple backend server and connected it to my MongoDB cluster. From there, I set up my site routes. I knew I would only need to get all data as well as post and patch requests, so there was no need to make a delete route or a get specific ID route.
  • I implemented a function to fetch data at whatever interval I specified–ultimately, this interval would be set to once daily. For testing however, I set it to every 1 - 10 minutes to help me find bugs. The database created by the inconsistent fetching intervals was deleted once I took the project into the production stage.

Step 3: React:

  • Once the backend was working efficiently, I began planning my site layout in Figma. I knew that there would be unexpected problems/features that popped up during development of the frontend that I would want to address. Therefore, I kept this initial layout rough in preparation to change the site as I went.
  • As this was my biggest project to date, I quickly realized that the way I set up my files was not ideal for a project of this size. I needed to change my entire file structure in order to optimize for future scaling as well as best practices.

Step 4: Deployment:

  • I chose to deploy my app on Heroku. The main two reasons for this choice were that I had previous experience with Heroku and was familiar with it, and because it was free and performs very well.

Performance

  • The first major performance improvement I made was utilizing memoization (caching the result of a function's output). Before doing so, each different page load was making an independent fetch request to my API; after making this change, my load times were greatly reduced. I implemented this by setting a global context that stored the fetched data. The page would only make another fetch request if manually refreshed by the user, not every time internal pages were routed to. You will now notice that when clicking on one of the top 10 coins from the home page, its corresponding chart will load instantly as well as when you return back to the home page.

  • After running a Lighthouse audit, I noticed that loading of all of my API data was taking a long time. I implemented compression middleware and as a result, my time to interactive went from 1.3 seconds down to 0.8 - 0.9 seconds.


What I learned

From small housekeeping lessons to structural changes in how I consider complex processes, I learned a lot through the creation of Top Coins. The most important concepts I learned from this experience that I believe have made me into a better developer are:

  1. How to utilize dynamic data in a website. For example: making dynamic routes or making charts that can handle dynamic data.

  2. Organization is crucial from the very beginning of the project. Moving forward, I will lay out my file structure early on in the planning stage of each new project. Planning for and constructing the file structure around the largest possible size for my project is one way I will approach this.

  3. React hooks! Before this project, I had heard of React hooks, but I was putting off learning about what they were, as the topic seemed daunting. In this project, thanks to the suggestion from someone on the 100Devs Discord, I spent a few hours diving into React hooks and how to build a custom React hook. I ended up using many built-in React hooks, and even building a custom hook that I needed for my project (/client/src/hooks/useFetchData.js). By the end of the project, I was very confident with useContext, useState, and useEffect.


Continued development

  • Currently, the Top Coins site is not responsive or mobile friendly. The main purpose of this project was to improve my talents in MERN, so I prioritized that first. In the coming months I plan to have this site fully responsive.

  • Right now, all of the links in the dropdown menus lead to external sources. Ideally, I would like to host all of this information internally. There is still a lot to plan here and think about, so this improvement might be a ways off.

  • The last big area that could be improved is the individual coin charts. After around 250 data points are shown on the chart at a time, the chart starts lagging when you move your cursor over it. To solve this, I have limited the chart to show the 100 most recent data points at a time. This is not currently a concern, as it is highly unlikely that within a year, a single coin will have accumulated over 100 data points. However, I know that my site should be prepared for any situation. My solution to optimize this is to either:

    1. Display the data with a method similar to other coin tracker sites and have range selectors. If the user selects "all time data," the site would average the selected coin’s price history into an array of 100 data points.

    2. Make a page system with two clickable arrows or a horizontal scroll bar which would display 100 data points on each page. This would be ideal for getting the exact dates of when the coin was in the top 10 coins of the day. For accuracy, I will most likely choose this option.


Useful resources

  • Chart.js has really great, detailed, and easy to read documentation, and this was one of my best resources.

  • Web Dev Simplified - Kyle makes incredible tutorials on all things web development. I used his custom React hooks tutorial for this project.

  • The Net Ninja - Shaun also has some amazing tutorial series on his channel. I used his React series for help setting up my dynamic routes on my site.


Acknowledgments

Thank you to fellow 100 Devs folks, especially a helpful Discord user for conducting a code review with me on my project, and for helping me with a few React challenges I faced. Also, a big thanks to octoshrimpy for helping me with the site's favicon, and countless random troubleshooting sessions.

About

Top 10 best performing crypocurrencies

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published