/crypto-bro

Crypto-Bro is a simple project that provides information and statistics on various cryptocurrencies.

Primary LanguageTypeScript

Crypto-Bro

  • About: Crypto-Bro is a cryptocurrency information and statistics web application that provides dynamic data visualization. It's developed with React, a robust JavaScript library, and styled using the versatile Tailwind CSS framework.

  • Live Demo: Experience the app's real-time cryptocurrency data and interactive charts by visiting the live demo.

  • Figma UI: The user interface and design elements of the app were thoughtfully crafted using Figma. To explore the design in more detail, check out the Figma UI.

Installation

Before you can run the project, make sure you have Node.js and npm installed on your system. To get started, follow these steps:

Clone this repository to your local machine:

git clone https://github.com/ilz5753/crypto-bro.git

Change to the project directory:

cd crypto-bro

Install the project dependencies:

npm install

Usage

To run Crypto-Bro, you can use the following npm scripts:

  • npm start: Runs the app in development mode. You can access it at http://localhost:3000 in your web browser.

  • npm build: Builds the app for production use. The build files will be located in the build directory.

  • npm test: Launches the test runner in the interactive watch mode.

  • npm eject: This script will eject the app from Create React App's configuration, which will allow you to customize the build setup. Use with caution.

Dependencies

Crypto-Bro relies on several third-party packages and libraries, including but not limited to:

  • @canvasjs/charts and @canvasjs/react-charts: Used for interactive charting.
  • @nextui-org/react: Provides UI components and theming.
  • date-fns: A utility library for working with dates.
  • framer-motion: Adds animation capabilities to the app.
  • lodash: A utility library for various operations.
  • react-icons: Provides a collection of icons for use in the app.
  • tailwind-scrollbar and tailwindcss: Used for styling and custom scrollbar implementation.
  • typescript: The programming language used for this project. usehooks-ts: Contains custom React hooks.
  • web-vitals: Helps measure real user performance of your web app. Please refer to the package.json file for a complete list of dependencies and their respective versions.

Contributing

If you'd like to contribute to Crypto-Bro, feel free to fork this repository, make your changes, and submit a pull request. Your contributions are welcome!

License

Crypto-Bro is open-source software licensed under the MIT License. You can use, modify, and distribute this code for your projects. However, please keep in mind to give appropriate credit and maintain the same license for derivative works.

Happy coding! 🚀