From ab2dfde10e51212b400f21b2eeb132653470b1d1 Mon Sep 17 00:00:00 2001 From: anshkush92college Date: Sun, 26 Mar 2023 00:53:21 +0530 Subject: [PATCH] Updating the readme regarding the docker compose command Signed-off-by: anshkush92college --- README.md | 39 +++++++++++++++++++++------------------ 1 file changed, 21 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index b5cc372..b9afa19 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ - ![Logo](https://res.cloudinary.com/dicbnntfh/image/upload/v1671525723/spotify-clone/logo_tdxo2z.png) - # Crypto Hunter Welcome to the Crypto Hunter! This website allows you to easily track the real-time prices, market capitalizations, and rankings of various cryptocurrencies. @@ -13,14 +11,15 @@ Screenshots can be found here [Crypto Hunter ScreenShots](https://drive.google.c ## Features - Real-time tracking of cryptocurrency prices and market cap values -- Convert from one currency to another -- Supports multiple currencies (INR, USD, EUR ...) -- Real-time exchange rates +- Convert from one currency to another +- Supports multiple currencies (INR, USD, EUR ...) +- Real-time exchange rates - Supports Table Pagination for getting as many coins as you want - Line chart for viewing price changes over a selected time period - Favorite list for easy tracking of specific cryptocurrencies - Historical price data and information about total supply, circulation, trading volume, and market dominance -- Responsive design, can be seen at any screen +- Responsive design, can be seen at any screen +- Dockerized app for easier installation ## Tech Stack @@ -30,55 +29,59 @@ Screenshots can be found here [Crypto Hunter ScreenShots](https://drive.google.c - [Chart Js](https://www.chartjs.org/) - [Firebase](https://firebase.google.com/) +## Run Locally +Follow the steps below to run the app in your local environment +### Method 1 +Docker Compose -## Run Locally +```bash +docker compose up +``` + +### Method 2 Clone the project ```bash - git clone https://github.com/anshkush92college/crypto-hunter-mern +git clone https://github.com/anshkush92college/crypto-hunter-mern ``` Go to the project directory ```bash - cd crypto-hunter-mern +cd crypto-hunter-mern ``` Install dependencies ```bash - npm install +npm install ``` Start the server ```bash - npm run start +npm run start ``` - ## Acknowledgements - - [Coin Gecko API](https://www.coingecko.com/en/api/documentation) - - [Rest Countries API](https://restcountries.com/) +- [Coin Gecko API](https://www.coingecko.com/en/api/documentation) +- [Rest Countries API](https://restcountries.com/) ## Authors - [Ansh Singh](https://github.com/anshkush92college) - ## License [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/) - ## Roadmap - Add the forget password functionality - Add more integrations like News, Exchanges -- Improve Performance - +- Improve Performance