Cryptopanel
Cryptopanel copied to clipboard
Cryptopanel is a single page web app that is created using React and Redux and fetches data from CoinGecko API. The application allows users to get details of cryptocurrencies information.
Crypto Panel
Desktop View Representation |
---|
📗 Table of Contents
-
📖 About the Project
-
🛠 Built With
- Tech Stack
- Key Features
- 🚀 Live Demo
-
🛠 Built With
-
💻 Getting Started
- Setup
- Prerequisites
- Install
- Usage
- Run tests
- Deployment
- 👥 Authors
- 🔭 Future Features
- 🤝 Contributing
- ⭐️ Show your support
- 🙏 Acknowledgements
- ❓ FAQ (OPTIONAL)
- 📝 License
📖 [Crypto Panel]
[Cryptopanel] is Cryptopanel is a single-page web app that is created using React and Redux and fetches data from CoinGecko API. The application allows users to get details of cryptocurrency information.
🛠 Built With
Tech Stack
Key Features
- [Responsive layout]
- [UX/UI accessibility]
- [Dynamic data]
(back to top)
🚀 Live Demo
(back to top)
💻 Getting Started
To get a local copy up and running, follow these steps:
Prerequisites
In order to run this project you need:
- A browser of your choice.
- A text editor of your choice.
- An installed node.js on your local system
Setup
Clone this repository to your desired folder:
-
Use the following Commands:
cd your-desired-folder git clone [email protected]:ab-noori/Cryptopanel.git
Install
-
Install this project with:
npx create-react-app . npm start
Usage
-
Use the following commands to run the project on your local system:
npm run build npm run deploy
Run tests
-
Run the following script and style test:
npx eslint "**/*.{js,jsx}" npx eslint "**/*.{js,jsx}" --fix npx stylelint "**/*.{css,scss}" npx stylelint "**/*.{css,scss}" --fix
Deployment
-
1- install gh-pages with following command:
npm i gh-pages
-
2- Add homepage to project's jason file:
"homepage": "https://ab-noori.github.io/Cryptopanel",
-
3- Add the following scripts to the project's package.jason file:
"predeploy": "npm run build", "deploy": "gh-pages -d build ",
-
4- Finally run the following command:
npm run deploy
(back to top)
👥 Authors
👤 Abdul Ali Noori
- GitHub: @ab-noori
- Twitter: @AbdulAliNoori4
- LinkedIn: abdulali-noori
🔭 Future Features
- [ ] [Giving funtionality to search input]
- [ ] [Creating more professional sidebar panel]
- [ ] [Using charts and graph to disply the currencies data]
(back to top)
🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
(back to top)
⭐️ Show your support
If you like this project, give it a star.
(back to top)
🙏 Acknowledgments
First, I would like to thank Microverse and my coding partners. Second, I want to give credit to Nerd's lesson
YouTub Channel, its react tutorial
is really helpful, and third, I should give credit to Nelson Sakwa
, I got some inspirations from his design on Behance.
(back to top)
❓ FAQ (OPTIONAL)
-
How to make it mobile friendly?
- Put a viewport tag in the header
-
How to design the site?
- Draw a mockup before starting to code
(back to top)
📝 License
This project is MIT licensed.
(back to top)