Skip to content

sarkartanmay393/CompoundFinance-Clone

Repository files navigation

Compound Finance Market Clone

This project is a clone of the market page of the Compound Finance website. It aims to replicate the functionality and design of the original page. You can view the live version of the project here.

Project Overview

The Compound Finance Market Clone project recreates the market page of the Compound Finance website. It provides users with a simplified interface to view and interact with various financial assets available on the Compound Finance platform. Users can explore the different assets and borrowing, and other relevant details.

Technologies Used

The project utilizes the following technologies:

  • HTML
  • TypeScript
  • Etherjs
  • Wagmi
  • NextJS

Getting Started

To run the project locally, follow these steps:

  1. Clone the repository from GitHub:

    git clone https://github.com/sarkartanmay393/compound-finance-market-clone.git
    
  2. Navigate to the project directory:

    cd CompoundFinance-Clone
    
  3. Run these following commands:

    npm install
    npm run build
    
  4. Open the localhost:3000 file in your preferred web browser.

Project Structure

├── pages
│   └── ...
├── public
│   ├── icon.png
│   └── ...
├── next.config.js
├── package.json
├── README.md
└── ...

Project Structure Overview

  • pages: This directory contains the different pages of the application. Each file represents a page with its respective route.
  • public: This directory is used for static assets like images, icons, and fonts.
  • next.config.js: This file contains configuration settings for Next.js.
  • package.json: This file lists the project dependencies and contains scripts for running the application and tests.
  • README.md: The project's readme file containing information about the application.

This structure is a general guideline and can be adjusted based on the specific requirements.

Contribution Guidelines

If you wish to contribute to this project, please follow these guidelines:

  1. Fork the repository on GitHub.
  2. Create a new branch with a descriptive name for your feature or bug fix.
  3. Make your changes, ensuring that the code follows the project's coding style and conventions.
  4. Test your changes to ensure they function as expected.
  5. Commit your changes and push them to your forked repository.
  6. Submit a pull request, clearly describing the changes you have made.

Contact Information

If you have any questions or suggestions regarding the project, please feel free to reach out to me through my GitHub account: github.com/sarkartanmay393.