cryptopedia

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Cryptopedia

Cryptopedia is a Web-App for real-time data about crypto exchanges and market activity for over 75 cryptocurrencies exchanges around the World. Users can see Exchanges categorized by their country and also get to see different information's like Trading volumes, trading pairs and ranks.

🛠 Built With

Tech Stack

• HTML

• CSS

• Javascript

• React

• Webpack

• NPM

• Redux

• Jest

• TailwindCss

• Lighthouse (An open-source, automated tool for improving the quality of web pages. It has audits for performance, accessibility, progressive web apps, SEO and more).

• Webhint (A customizable linting tool that helps you improve your site's accessibility, speed, cross-browser compatibility, and more by checking your code for best practices and common errors).

• Stylelint (A mighty, modern linter that helps you avoid errors and enforce conventions in your styles).

Client

• React.js

Server

• Express.js

Database

• PostgreSQL

Key Features

• See list of Crypto Exchanges
• Search exchange by country or name
• View more detail about an exchange

(back to top)

🚀 Live Demo

• Live Link

🚀 Video Presentation

• Video Presentation

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

• npm

  npm install npm@latest -g

Setup

1. Clone the repo by running the command

    git clone https://github.com/V-Blaze/cryptopedia.git

2. Open the directory of the project

   cd cryptopedia

3. Install project dependencies

   run npm install

4. Open the html file

   run npm start
   

Run tests

To run tests, run the following command:

• npm

  npm run test

(back to top)

👥 Author

👤 Author

• GitHub: @V-blaze
• Twitter: @blaze_valentine
• LinkedIn: @valentine-blaze

(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 a start and a follow.

(back to top)

🙏 Acknowledgments

Original design idea by Nelson Sakwa on Behance.

(back to top)

Show your support

• Give a ⭐️ if you like this project!

(back to top)

📝 License

• This project is MIT licensed.
• This project is also Creative Common licensed.

(back to top)