Skip to content

pcon-hacktoberfest-21/crypto-tracker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Crypto Tracker

Image

Hi! Welcome to this beginner-friendly Frontend Engineering challenge for Hacktoberfest. A project focused on people getting started with frontend development with React where one can build a very cool personal realtime crypto tracker tracker.

Everyone is encouraged to participate, regardless of your skill level (If you don't have the required skills, use this project as a motivation to learn those!). This is a practice project and should be considered a playground.

Project Summary

You have to build a React based web application which will act as your personal console for the crypto market!

Using the apis and tools given below, try to implement the following features:

  • Minimum Required Features:

  • A home screen, where the users can view the details of the coin:

  • Minimum features to add for each coin:

    • Market Cap.

    • Volume.

    • Current value of a coin.

    • Rate of increasing/decreasing.

    • Real time updates.

  • A navbar or menubar to navigate between different screens

  • UI should be completely responsive! (i.e should be able to adapt accordingly for various device sizes)

  • Title should update accordingly

  • Nice-to-have Features

  • A login/signup feature.

  • Showing data in more than 1 currency(like INR, USD and others).

  • User can search the coin of their choice.

  • Pagination.

  • Graph showing ups and downs.

  • Sorting

APIs and Services to be used

  • APIs : For fetching all the coins, market cap, current value.

Guidelines

System requirements:

  • Make sure node version 12 or higher is installed on your system.

  • Make sure yarn version 1.19.1 or higher is installed on your system.

Please try to follow these guidelines:

  • Use only CSS/SCSS or Styled Components for styling the app, DON'T use bootstrap, material UI, semantic UI or any other styling library. (Haha! 😉 No shortcuts here 🤣)

  • Try to make the UI as elegant as possible, use Cards, box-shadows etc. Choose a subtle color-theme.

  • Prefer functional components over class components, use react hooks and react context apis as far as possible.

  • Unless absolutely necessary, don't use Redux for state management, try keeping things simple!

  • Only use images/content that are available for free and don't need any special license.

  • Last but not the least, use your imagination to build the coolest app you can think of ! 😻 🔥 🔥 🔥

How to Contribute

Note 1: If you've never made a pull request before, or participated in an open-source project, we recommend taking a look at this wonderful video tutorial. And if you want a more complete tutorial on using github, creating branches etc. , here's a detailed video series.Once you've got your feet wet, you're ready to come back and dive into Hacktoberfest fun!

Note 2: Super Important Only the pull requests created between October 1st, 2020 and October 31st, 2020 will be counted!

  1. Star this repository. 😛

  2. And then you have to fork (make a copy) of this repo to your Github account.

  3. Clone (download) your fork to your computer.

  4. Set your streams so you can sync your clone with the original repo (get the latest updates)

  5. Create a branch with your name (for e.g: if your name is John Wick, create a branch named John_Wick).

  6. Make the changes in your branch.

  7. Commit and push the code to YOUR fork.

  8. Create a pull request to have the changes merged into the origin.

Running the project locally

After downloading this repo, run the command yarn (or if using npm - npm install) in the project directory to install the dependencies.

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.

Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.

You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.

See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.

It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

Your app is ready to be deployed!

See the section about deployment for more information.

yarn eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

yarn build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

About

No description or website provided.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published