-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
37 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,70 +1,56 @@ | ||
| # Getting Started with Create React App | ||
| # CryptoPandey | ||
|
|
||
| This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). | ||
| CryptoPandey is a responsive website that provides you with latest news, stats and graphs related to cryptocurrency. | ||
|
|
||
| ## Available Scripts | ||
| ## Data | ||
| 1. Realtime price and stats of 100 top cryptocurrencies. | ||
| 2. Latest news related to cryptocurrency. | ||
| 3. Graph of cryptocurrency price over past 5 years. | ||
| 4. Exchange rates of cryptocurrencies. | ||
|
|
||
| In the project directory, you can run: | ||
|
|
||
| ### `npm start` | ||
| ## Tech Stack | ||
|
|
||
| Runs the app in the development mode.\ | ||
| Open [http://localhost:3000](http://localhost:3000) to view it in the browser. | ||
| **Client:** React, Redux, Ant Designs, Rapid API | ||
|
|
||
| The page will reload if you make edits.\ | ||
| You will also see any lint errors in the console. | ||
| **Server:** Firebase | ||
|
|
||
| ### `npm test` | ||
|
|
||
| ## Live Demo | ||
|
|
||
| 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. | ||
| https://cryptopandey-7df52.firebaseapp.com/ | ||
|
|
||
| ### `npm run build` | ||
|
|
||
| ## Installation | ||
|
|
||
| Builds the app for production to the `build` folder.\ | ||
| It correctly bundles React in production mode and optimizes the build for the best performance. | ||
| 1. Go to Rapid API website and signup with a free account. | ||
| 2. Go to CoinRanking API and generate an API key to place in API key section for prices inside the project. | ||
| 3. Go to Bing search API and generate API key to place it in API key section for news inside the project. | ||
|
|
||
| ## Run Locally | ||
|
|
||
| The build is minified and the filenames include the hashes.\ | ||
| Your app is ready to be deployed! | ||
| Clone the project | ||
|
|
||
| See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. | ||
| ```bash | ||
| git clone https://link-to-project | ||
| ``` | ||
|
|
||
| ### `npm run eject` | ||
| Go to the project directory | ||
|
|
||
| **Note: this is a one-way operation. Once you `eject`, you can’t go back!** | ||
| ```bash | ||
| cd my-project | ||
| ``` | ||
|
|
||
| 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. | ||
| Install dependencies | ||
|
|
||
| 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. | ||
| ```bash | ||
| npm install | ||
| ``` | ||
|
|
||
| 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. | ||
| Start the server | ||
|
|
||
| ## Learn More | ||
| ```bash | ||
| npm run start | ||
| ``` | ||
|
|
||
| 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) | ||
|
|