From 879cd8fda27872386091813094eddaf65024211c Mon Sep 17 00:00:00 2001 From: Nitish <73771450+Nitish-JS@users.noreply.github.com> Date: Fri, 4 Jul 2025 15:26:54 +0530 Subject: [PATCH] Add installation instructions and MIT license --- LICENSE | 21 +++++++++++++++++++++ README.md | 38 ++++++++++++++++++++++++++++++++++++-- 2 files changed, 57 insertions(+), 2 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d18f663 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 CryptoHunter + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 9c41ebd..848d0e3 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,38 @@ +# CryptoHunter -View the deployed site on the following link +CryptoHunter is a React-based cryptocurrency tracker that displays prices, market data and charts for various coins. -https://cryptohunter-nitish.netlify.app/ +## Installation + +1. Ensure you have [Node.js](https://nodejs.org/) installed (Node 14 or later is recommended). +2. Install project dependencies: + +```bash +npm install +``` + +## Running the Development Server + +Start the application with: + +```bash +npm start +``` + +This runs the app in development mode on [http://localhost:3000](http://localhost:3000). The page will reload if you make edits. + +## Building for Production + +To create an optimized production build: + +```bash +npm run build +``` + +The build output will be placed in the `build/` directory. + +## Live Demo + +A deployed version of the site can be found at: + +