Welcome to TVL-APY-CALCULATOR! This is a Next.js project that fetches data from an API and calculates TVL (Total Value Locked) and APY (Annual Percentage Yield) for a Balancer pool.
This project utilizes Next.js to create a web application that fetches data from the Balancer API and calculates TVL and APY for a specific Balancer pool. It showcases the use of React hooks and useEffect to manage API calls and state in a functional component.
- Create a next app and copy the index.js file into that folder:
npx create-next-app next-table-example
- Install the dependencies:
npm install
-
Replace the API URL in the
useEffect
hooks with the correct URL for your Balancer pool. -
Run your docker application.
-
To start the development server, run:
npm run dev
- Open your web browser and go to
http://localhost:3000
to see the application in action.
Contributions are welcome! If you find any issues or want to enhance the project, feel free to open a pull request. Please ensure to follow the existing code style and commit conventions.
-
Fork the repository.
-
Create a new branch:
git checkout -b feature/your-feature-name
-
Make your changes, commit them, and push to your forked repository.
-
Open a pull request detailing your changes and improvements.
This project is licensed under the MIT License.
Feel free to customize the sections and content as needed to accurately represent your project. Make sure to replace placeholders like yourusername
and project-name
with actual values.
Remember that the quality of your README file can greatly impact how others perceive and interact with your project. Providing clear instructions, explanations, and examples will make it easier for others to understand and contribute to your code.