Skip to content

Commit

Permalink
docs: updates readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
Vaishali785 committed Jan 26, 2024
1 parent a53f9bd commit 42afd84
Show file tree
Hide file tree
Showing 11 changed files with 94 additions and 39 deletions.
28 changes: 14 additions & 14 deletions .firebase/hosting.YnVpbGQ.cache
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
asset-manifest.json,1705259536699,7c8b4d9ba3982093731a9e0552526600d5e9168f4c441621d80c71cdd54105ac
index.html,1705259536699,4071aaa51151e89fba396874c1f2da88c5543818948b462a4df66c72ad8b4209
static/js/2.35fdc39c.chunk.js.LICENSE.txt,1705259536715,c72cb011e76d1c12a2d67efc48d4353444a56be7afeb696e81384e40b1ad7485
static/css/main.9fb255cd.chunk.css,1705259536715,71effe40ef6ab86ecc378b5385520860d45ae8ecc93bbb521ffcc3d979f3461c
static/css/main.9fb255cd.chunk.css.map,1705259536718,0b05d3c8bdc6462bf164ec48a052f51c165e5cc50d2626d1835f422e26623b97
static/js/main.6ab39d10.chunk.js,1705259536715,4b040c94168d8828067c970118224a808bfc56640309022e05161097c94dcba7
static/js/runtime-main.e0c2315a.js.map,1705259536718,c261cdb859607dbc40b0cef40b7f7a28e2e775fea4564e5a0da11d8dbda7dca8
static/js/runtime-main.e0c2315a.js,1705259536719,68f4098a71ecb047a713110a1fb01bc66b1810079061ee82d2effdb8d430e130
static/js/main.6ab39d10.chunk.js.map,1705259536716,16cd5ede0f62c1549a872c78b7a678f8a83d3416dd86d8cb8d1ebf073571b261
favicon.png,1705259525799,bc3fa4d7e7b8059364140dded759addfd8f7f50115c5c73a7c97fada4f68ab50
static/css/2.c23eed97.chunk.css,1705259536716,56b0dcfa21f1104e644f3e880ac5bbd37b29868bfb37b122184529679f547a9d
static/js/2.35fdc39c.chunk.js,1705259536719,e6d12024334264e4a72f129dd3ee2f96cfbbb5b4d6eac14bbf69fa47077c28de
static/css/2.c23eed97.chunk.css.map,1705259536718,13c38c451fa065b4a76672a063a8378ba75f00e3e1b79bed662503b45cbaad72
static/js/2.35fdc39c.chunk.js.map,1705259536718,e12fcb1a0d1fb308ff190add8a4404cf0149c9c8b68e37fc069f7dc4fffb8bf1
asset-manifest.json,1706171295988,cd0c33177ccc3e792f41a3e2749249a709cc5b955ab9dddd3dd4f7ecdfcb5145
index.html,1706171295988,4838844191e0ec7ac882bbf22b19836b8088a487e807cf1b6d26464cd575dac0
static/css/main.9fb255cd.chunk.css,1706171296009,71effe40ef6ab86ecc378b5385520860d45ae8ecc93bbb521ffcc3d979f3461c
static/css/main.9fb255cd.chunk.css.map,1706171295993,0b05d3c8bdc6462bf164ec48a052f51c165e5cc50d2626d1835f422e26623b97
static/js/2.2de645be.chunk.js.LICENSE.txt,1706171295997,c72cb011e76d1c12a2d67efc48d4353444a56be7afeb696e81384e40b1ad7485
static/js/runtime-main.e0c2315a.js,1706171295993,68f4098a71ecb047a713110a1fb01bc66b1810079061ee82d2effdb8d430e130
static/js/runtime-main.e0c2315a.js.map,1706171296010,c261cdb859607dbc40b0cef40b7f7a28e2e775fea4564e5a0da11d8dbda7dca8
static/js/main.0c96b6eb.chunk.js,1706171296010,d432ac58780bf21b68a849ad41b347275a9c5fc120adafd061cd257e680354e9
favicon.png,1706171270612,bc3fa4d7e7b8059364140dded759addfd8f7f50115c5c73a7c97fada4f68ab50
static/js/main.0c96b6eb.chunk.js.map,1706171296010,62bbde07987ac76fcef84c034e4c577b676faed007cc89b2af4d833e3fb4b3c5
static/css/2.c23eed97.chunk.css,1706171296009,56b0dcfa21f1104e644f3e880ac5bbd37b29868bfb37b122184529679f547a9d
static/js/2.2de645be.chunk.js,1706171296009,f725a9291e2dd324b861155d9c69471add53e2c1c8589f9d0bd04bf2e3066a30
static/css/2.c23eed97.chunk.css.map,1706171296010,13c38c451fa065b4a76672a063a8378ba75f00e3e1b79bed662503b45cbaad72
static/js/2.2de645be.chunk.js.map,1706171296010,54bbae87d45c78468160bda38fc92ad1c2e446783e1b33cd29ac8d73bfda09e1
73 changes: 64 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,73 @@
# Project Title
# CryptoVerse

CryptoVerse
A ReactJS project that provides detailed information about various cryptocurrencies, including real-time graphs. Styled with Ant Design, utilizing ChartJS for graph visualization, fetching data from Rapid API, and hosted on Firebase.

# Demo link:
For a live demonstration, explore [CryptoVerse Demo](https://cryptoversebyvaishali.web.app).

https://cryptoversebyvaishali.web.app/
## Table of Contents

# Technologies
- [Overview](#overview)
- [Features](#features)
- [Tech Stack](#tech-stack)
- [API](#api)
- [Dependencies](#dependencies)

- ReactJS
- AntD
- ChartJS
- RapidAPI
## Overview

CryptoVerse is a comprehensive platform for cryptocurrency enthusiasts, providing detailed information about various cryptocurrencies along with real-time graphs for in-depth analysis. The application is built using ReactJS, styled with Ant Design, and hosted on Firebase.

## Features

- **Cryptocurrency Details**: Explore detailed information about various cryptocurrencies.
- **Real-time Graphs**: Visualize the performance of cryptocurrencies with real-time graphs powered by ChartJS.
- **Ant Design Styling**: Enjoy a polished and user-friendly interface with the elegance of Ant Design.
- **Search Functionality**: Easily find specific cryptocurrencies using the intuitive search feature, making navigation and research efficient.
- **Redux State Management**: Efficiently manage the application's state with Redux, ensuring a centralized and predictable state flow across components.
- **React Router Navigation**: Seamlessly navigate between different pages and components with the integration of React Router, ensuring a smooth and intuitive user experience.
- **React Query Data Management**: Optimize data fetching, caching, and state management with React Query, providing efficient and performant data handling for an improved user interface.

## Tech Stack

<p align="left"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/skills/react-colored.svg" width="50" height="50" alt="React" />
<img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/skills/redux-colored.svg" width="50" height="50" alt="Redux" />
<img alt='React-Query' height="50" width="50" src='https://seeklogo.com/images/R/react-query-logo-1340EA4CE9-seeklogo.com.png'>
<img alt='React-Router' height="50" width="100" src='https://reactrouter.com/_brand/react-router-stacked-color-inverted.png'>
<img src="https://i.pinimg.com/originals/9a/0e/a9/9a0ea991a4367065727f9754e2e09493.png" width="50" height="50" alt="Ant Design" />
<img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/skills/firebase-colored.svg" width="50" height="50" alt="Firebase" />

</p>

- **Frontend**: ReactJS
- **Styling**: Ant Design
- **Navigation**: React Router
- **State Management**: Redux
- **Data Management**: React Query
- **Graph Visualization**: ChartJS
- **Data Fetching**: Rapid API
- **Hosting**: Firebase

## API

This project fetches cryptocurrency data from Rapid API. To set up the necessary API key, follow these steps:

1. Create a `.env` file in the root of your project.
2. Add the following line to the `.env` file:
```env
REACT_APP_RAPID_API_KEY=your_rapid_api_key_here
```
Replace `your_rapid_api_key_here` with your actual Rapid API key.

## Dependencies

- [React](https://reactjs.org/)
- [Ant Design](https://ant.design/)
- [ChartJS](https://www.chartjs.org/)
- [Rapid API](https://rapidapi.com/)
- [Firebase](https://firebase.google.com/)

For a complete list of dependencies, refer to the `package.json` file.

<!-- Hosted on Main branch -->
<!-- Master branch contains the code of initial deployed website, so don't change anything here. -->
<!-- Do all the changes on New branch and then merge it in main -->
<!-- nvm default works for this project -->
14 changes: 7 additions & 7 deletions build/asset-manifest.json
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
{
"files": {
"main.css": "/static/css/main.9fb255cd.chunk.css",
"main.js": "/static/js/main.6ab39d10.chunk.js",
"main.js.map": "/static/js/main.6ab39d10.chunk.js.map",
"main.js": "/static/js/main.0c96b6eb.chunk.js",
"main.js.map": "/static/js/main.0c96b6eb.chunk.js.map",
"runtime-main.js": "/static/js/runtime-main.e0c2315a.js",
"runtime-main.js.map": "/static/js/runtime-main.e0c2315a.js.map",
"static/css/2.c23eed97.chunk.css": "/static/css/2.c23eed97.chunk.css",
"static/js/2.35fdc39c.chunk.js": "/static/js/2.35fdc39c.chunk.js",
"static/js/2.35fdc39c.chunk.js.map": "/static/js/2.35fdc39c.chunk.js.map",
"static/js/2.2de645be.chunk.js": "/static/js/2.2de645be.chunk.js",
"static/js/2.2de645be.chunk.js.map": "/static/js/2.2de645be.chunk.js.map",
"index.html": "/index.html",
"static/css/2.c23eed97.chunk.css.map": "/static/css/2.c23eed97.chunk.css.map",
"static/css/main.9fb255cd.chunk.css.map": "/static/css/main.9fb255cd.chunk.css.map",
"static/js/2.35fdc39c.chunk.js.LICENSE.txt": "/static/js/2.35fdc39c.chunk.js.LICENSE.txt"
"static/js/2.2de645be.chunk.js.LICENSE.txt": "/static/js/2.2de645be.chunk.js.LICENSE.txt"
},
"entrypoints": [
"static/js/runtime-main.e0c2315a.js",
"static/css/2.c23eed97.chunk.css",
"static/js/2.35fdc39c.chunk.js",
"static/js/2.2de645be.chunk.js",
"static/css/main.9fb255cd.chunk.css",
"static/js/main.6ab39d10.chunk.js"
"static/js/main.0c96b6eb.chunk.js"
]
}
2 changes: 1 addition & 1 deletion build/index.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!doctype html><html lang="en"><head><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1,shrink-to-fit=no"/><meta name="theme-color" content="#000000"/><link rel="manifest" href="/manifest.json"/><link rel="shortcut icon" href="./favicon.png"/><title>CryptoVerse</title><link href="/static/css/2.c23eed97.chunk.css" rel="stylesheet"><link href="/static/css/main.9fb255cd.chunk.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div><script>!function(e){function r(r){for(var n,l,p=r[0],f=r[1],i=r[2],c=0,s=[];c<p.length;c++)l=p[c],Object.prototype.hasOwnProperty.call(o,l)&&o[l]&&s.push(o[l][0]),o[l]=0;for(n in f)Object.prototype.hasOwnProperty.call(f,n)&&(e[n]=f[n]);for(a&&a(r);s.length;)s.shift()();return u.push.apply(u,i||[]),t()}function t(){for(var e,r=0;r<u.length;r++){for(var t=u[r],n=!0,p=1;p<t.length;p++){var f=t[p];0!==o[f]&&(n=!1)}n&&(u.splice(r--,1),e=l(l.s=t[0]))}return e}var n={},o={1:0},u=[];function l(r){if(n[r])return n[r].exports;var t=n[r]={i:r,l:!1,exports:{}};return e[r].call(t.exports,t,t.exports,l),t.l=!0,t.exports}l.m=e,l.c=n,l.d=function(e,r,t){l.o(e,r)||Object.defineProperty(e,r,{enumerable:!0,get:t})},l.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},l.t=function(e,r){if(1&r&&(e=l(e)),8&r)return e;if(4&r&&"object"==typeof e&&e&&e.__esModule)return e;var t=Object.create(null);if(l.r(t),Object.defineProperty(t,"default",{enumerable:!0,value:e}),2&r&&"string"!=typeof e)for(var n in e)l.d(t,n,function(r){return e[r]}.bind(null,n));return t},l.n=function(e){var r=e&&e.__esModule?function(){return e.default}:function(){return e};return l.d(r,"a",r),r},l.o=function(e,r){return Object.prototype.hasOwnProperty.call(e,r)},l.p="/";var p=this.webpackJsonpcryptoverse=this.webpackJsonpcryptoverse||[],f=p.push.bind(p);p.push=r,p=p.slice();for(var i=0;i<p.length;i++)r(p[i]);var a=f;t()}([])</script><script src="/static/js/2.35fdc39c.chunk.js"></script><script src="/static/js/main.6ab39d10.chunk.js"></script></body></html>
<!doctype html><html lang="en"><head><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1,shrink-to-fit=no"/><meta name="google-site-verification" content="wzLu4qMeBgke5dqysXjEvCBegKZo7a8u-3LUYGQOZ_4"/><meta name="theme-color" content="#000000"/><link rel="manifest" href="/manifest.json"/><link rel="shortcut icon" href="./favicon.png"/><title>CryptoVerse</title><link href="/static/css/2.c23eed97.chunk.css" rel="stylesheet"><link href="/static/css/main.9fb255cd.chunk.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div><script>!function(e){function r(r){for(var n,l,p=r[0],f=r[1],i=r[2],c=0,s=[];c<p.length;c++)l=p[c],Object.prototype.hasOwnProperty.call(o,l)&&o[l]&&s.push(o[l][0]),o[l]=0;for(n in f)Object.prototype.hasOwnProperty.call(f,n)&&(e[n]=f[n]);for(a&&a(r);s.length;)s.shift()();return u.push.apply(u,i||[]),t()}function t(){for(var e,r=0;r<u.length;r++){for(var t=u[r],n=!0,p=1;p<t.length;p++){var f=t[p];0!==o[f]&&(n=!1)}n&&(u.splice(r--,1),e=l(l.s=t[0]))}return e}var n={},o={1:0},u=[];function l(r){if(n[r])return n[r].exports;var t=n[r]={i:r,l:!1,exports:{}};return e[r].call(t.exports,t,t.exports,l),t.l=!0,t.exports}l.m=e,l.c=n,l.d=function(e,r,t){l.o(e,r)||Object.defineProperty(e,r,{enumerable:!0,get:t})},l.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},l.t=function(e,r){if(1&r&&(e=l(e)),8&r)return e;if(4&r&&"object"==typeof e&&e&&e.__esModule)return e;var t=Object.create(null);if(l.r(t),Object.defineProperty(t,"default",{enumerable:!0,value:e}),2&r&&"string"!=typeof e)for(var n in e)l.d(t,n,function(r){return e[r]}.bind(null,n));return t},l.n=function(e){var r=e&&e.__esModule?function(){return e.default}:function(){return e};return l.d(r,"a",r),r},l.o=function(e,r){return Object.prototype.hasOwnProperty.call(e,r)},l.p="/";var p=this.webpackJsonpcryptoverse=this.webpackJsonpcryptoverse||[],f=p.push.bind(p);p.push=r,p=p.slice();for(var i=0;i<p.length;i++)r(p[i]);var a=f;t()}([])</script><script src="/static/js/2.2de645be.chunk.js"></script><script src="/static/js/main.0c96b6eb.chunk.js"></script></body></html>

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions build/static/js/2.2de645be.chunk.js.map

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion build/static/js/2.35fdc39c.chunk.js.map

This file was deleted.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion public/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
name="viewport"
content="width=device-width, initial-scale=1, shrink-to-fit=no"
/>
<meta name="google-site-verification" content="p0l_2Je1BgB9l0F1Sh-60vYIgwL-nHvDagfr3YnrCEw" />
<meta name="google-site-verification" content="wzLu4qMeBgke5dqysXjEvCBegKZo7a8u-3LUYGQOZ_4" />
<meta name="theme-color" content="#000000" />
<!--
manifest.json provides metadata used when your web app is added to the
Expand Down

0 comments on commit 42afd84

Please sign in to comment.