Git Product home page Git Product logo

starkfarm-client's Introduction

STRKFarm

STRKFarm is a platform that allows users to better navigate DeFi on Starknet. It has the following features:

  1. Show top yield generating pools sorted by Protocols and various Categories. 10+ Protocols are integrated. โœ…
  2. Customized strategies, providing one-click investment with automated risk-management โœ… (Adding more)
  3. Concentrated Liquidity Impermanent calculator ๐Ÿšง
  4. One click $STRK claim for DeFi spring users ๐Ÿšง

Project structure

The project is build using NextJS and Typescript. Below is the broad project structure:

  1. Re-usable project wide components go into src/components. Page specific components go into their respective folder. (e.g. src/app/claims/components)
  2. We use Jotai for state management. Atoms are written in src/store. E.g. src/store/strategies.atoms.ts. Most re-usable data is written into atoms, outside components so that data is eaily accessible across components without dumping custom logic into components. Its suggested to keep view components low on business logic code.
  3. All protocols have a class object (e.g. src/store/ekubo.store.ts). Where protocol specific custom logic is written, so that its get written to respective Atoms.
  4. You can use src/store/IDapp.store.ts to define abstract class or type definitions that can be used within protocol class objects.
  5. Custom re-usable hooks are written to src/hooks.

How to get started

Pull Requests welcome Requirements:

  1. Node 20+

Clone the repository

git clone https://github.com/strkfarm/starkfarm-client.git

Install dependencies and run the development build

yarn

yarn run dev

You should see something like this:

> [email protected] dev
> next dev

   โ–ฒ Next.js 14.1.0
   - Local:        http://localhost:3000
   - Environments: .env

 โœ“ Ready in 1431ms

๐Ÿค Contribute

We're always looking for for stallions with great NextJS & Typescript skills to further this tool, to join our community and contribute to STRKFarm. Check out our contributing guide for more information on how to get started.

To connect with us regarding any queries about contributing to the repo, feel free to join our telegram group here. Head to dev topic.

References

Contributors โœจ

Thanks goes to these wonderful people.

Akira
Akira

๐Ÿค” ๐Ÿ’ป ๐Ÿš‡
Hemant
Hemant

๐Ÿš‡
Wolf
Wolf

๐Ÿš‡
Jed
Jed

๐Ÿ’ป
Emmaunuel Ejembi
Emmaunuel Ejembi

๐Ÿ’ป ๐Ÿ“–
Catherine Jonathan
Catherine Jonathan

๐Ÿ’ป
Neelkanth Tandel
Neelkanth Tandel

๐Ÿ‘€
Ugonna Paul Dike
Ugonna Paul Dike

๐Ÿ’ป
Fishon Amos
Fishon Amos

๐Ÿ’ป

All Contributors

starkfarm-client's People

Contributors

akiraonstarknet avatar allcontributors[bot] avatar hemantwasthere avatar ugo-x avatar ejembiemmanuel avatar raizo07 avatar fishonamos avatar jemiiah avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.