Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
FroZen-07 authored Sep 15, 2023
1 parent 53e28ec commit 020a6b3
Showing 1 changed file with 22 additions and 60 deletions.
82 changes: 22 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,32 @@
# Getting Started with Create React App
# CryptoHub App

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
CryptoHub App is a React app that allows you to track the live data of over 100 cryptocurrencies. You can see the price, name, and symbol of each cryptocurrency, as well as search for a specific one. The app uses Axios to fetch data from various APIs, such as [CoinGecko] and [CoinMarketCap].

## Available Scripts
## Demo

In the project directory, you can run:
You can view the deployed version of the app [(https://frozen-07.github.io/cryptohub-react/)].

### `npm start`
## Installation

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
To run the app locally, you need to have [Node.js] and [npm] installed on your machine. Then, follow these steps:

The page will reload when you make changes.\
You may also see any lint errors in the console.
1. Clone this repository to your local machine.
2. Navigate to the project directory and run `npm install` to install the dependencies.
3. Run `npm start` to start the development server.
4. Open [http://localhost:3000] in your browser to view the app.

### `npm test`
## Features

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
- Responsive design that adapts to different screen sizes and devices.
- Reusable card components that display the cryptocurrency data in a user-friendly way.
- Search functionality that allows you to filter the cryptocurrencies by name or symbol.
- Loading and error states that handle the API requests and responses.

### `npm run build`
## Technologies

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](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `npm run 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](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).

### Code Splitting

This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](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](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](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](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](https://facebook.github.io/create-react-app/docs/deployment)

### `npm run build` fails to minify

This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
- React JS - A JavaScript library for building user interfaces.
- JavaScript - A scripting language that enables dynamic and interactive web pages.
- CSS - A style sheet language that describes the presentation of web pages.
- HTML - A markup language that defines the structure of web pages.
- Axios - A promise-based HTTP client for the browser and Node.js.
- APIs - Application programming interfaces that provide data and functionality from external sources.

0 comments on commit 020a6b3

Please sign in to comment.