Isabellanamutenda/Final-react-capstone-project

Crypto Stats

Table of Contents

• About Project
• Built With
• Getting Started
• API Interactions
• Contributing
• Author
• Acknowledgements
• Show your support

About Project

"Crypto Stats" is a web application that keeps track of cryptocurrency statistics. This application presents a user with a list of cryptocurrencies sorted in the order of their current market prices. A user can then click on one of othe currencies to be directed to a details page with more stats on that particular cryptocurrency. This project uses Coinstats API which is a public REST API for information on cryptocurrencies.

Live Demo - Netlify

Recorded video

Built With

• ReactJS
• Redux
• Coinstats API

Getting Started

• Clone this repo https://github.com/Isabellanamutenda/Final-react-capstone-project.git

  git clone https://github.com/Isabellanamutenda/Final-react-capstone-project.git
  
  

• Navigate to crypto-stats folder/directory

  cd Final-react-capstone-project
  

• On the comandline, at the project's root, run npm install to install app dependencies

• Next, run npm start which will run the app in the development mode.

• Open http://localhost:3000 to view it in the browser.

• ALTERNATIVELY

  • Just run npm run build which will build the project and generate output files into the build directory.

  • Go to build directory and manually open index.html to interact with the app

• Run npm run test to run tests.

API Interactions

From Coinstats API, this app/project is interacting/consuming the following endpoints:

• Base URL - https://api.coinstats.app/public/v1
• Fetching and Loading Coins - Method(GET) - https://api.coinstats.app/public/v1/coins
• Fetching and Loading a Coin by id i.e. "bitcoin"- Method(GET) - https://api.coinstats.app/public/v1/bitcoin

Take a look at the DOCUMENTATION for further insights.

Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/newFeature)
3. Commit your Changes (git commit -m 'Add some newFeature')
4. Push to the Branch (git push -u origin feature/newFeature)
5. Open a Pull Request

Author

👤 Isabella Namutenda

• GitHub: Isabellanamutenda
• Twitter: @INamtenda
• LinkedIn: Isabella Namutenda

Acknowledgements

• Nelson Sakwa from https://www.behance.net/ for the awesome design that this project is based on.
• Developers at https://coinstats.app/ for the API that this project consumes.
• ReactJS Organization for the amazing Documentation on React.
• Redux Organization for the amazing Redux Essentials Tutorial on Redux.

Show your support

Give a ⭐️ if you like this project!