Parraton Webapp

Parraton is a decentralized, permission-less, open-source yield optimization protocol on TON blockchain. Visit parraton.org for more information.

Parraton consists of these components:

Contract: The smart contract code that is running on-chain.

Webapp: The web application that helps users with deposits and withdrawals. The code is available here on this repository.

Restaker: The off-chain bot that restakes rewards to generate more yield for depositors.

Table of Contents

• Overview
• Getting Started
  • Prerequisites
  • Installation
  • Running the Development Server
• Scripts
• Main Dependencies
• Project Structure
• Contributing
• License

Overview

Parraton simplifies the process of reinvesting in DeDust by providing an intuitive platform with enhanced security and performance.

Getting Started

Prerequisites

Ensure you have the following installed on your local development machine:

• Node.js (>= 14.0.0)
• pnpm (>= 6.0.0)

Installation

1. Clone the repository:

   git clone https://github.com/digberi/parroton.git

2. Navigate to the project directory:

   cd parroton

3. Install the dependencies:

   pnpm install

Running the Development Server

To start the development server, run:

pnpm dev

The application will be available at http://localhost:3000.

Scripts

• setup: Executes the setup script (./scripts/setup.js).
• prebuild: Executes the prebuild script (./scripts/prebuild.js).
• dev: Runs setup and starts the Next.js development server.
• build: Runs prebuild and builds the Next.js application for production.
• start: Starts the Next.js application in production mode.
• lint: Runs the Next.js linting process.
• oxlint: Runs the custom oxlint with specific plugins and configurations.
• g: Adds a new component using the Shadcn-UI generator.
• type-locales: Generates TypeScript types for i18n locales.
• dr:build: Builds the declarative routing configuration.
• dr:build:watch: Watches for changes and rebuilds the declarative routing configuration.
• prepare: Runs Husky to prepare Git hooks.

Main Dependencies

Production

• Next.js: React framework for server-rendered applications.
• React: JavaScript library for building user interfaces.
• TailwindCSS: Utility-first CSS framework.
• i18next: Internationalization library.
• Formik: Form management library for React.
• Ton: Libraries for TON blockchain integration.
• DeDust SDK: SDK for interacting with DeDust services.

Development

• TypeScript: Superset of JavaScript that adds static typing.
• ESLint: Linting utility for JavaScript and TypeScript.
• Prettier: Code formatting tool.
• Husky: Git hooks manager.
• Declarative Routing: Declarative routing configuration.

Project Structure

• /public: Static assets.
• /src: Source code.
  • /components: React components.
  • /app: Next.ja app routing and configuration.
  • /core: Core application logic.
  • /hooks: Custom React hooks.
  • /i18n: Internationalization resources.
  • /routes: Declarative routing configuration.
  • /styles: Styling files.
  • /utils: Utility functions.

Contributing

Contributions are welcome! Please follow the established code style and conventions. For major changes, open an issue first to discuss what you would like to change.

License

This project is licensed under the MIT license.

See LICENSE for more information.

Made with 💙💛 by mad.fish