Translat3

A Web3 powered Localization Platform
Explore the docs »

· Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Acknowledgments

About The Project

Translat3 is a community powered platform that can help you localize your product. Since it runs on Web3, translat3 has no global boundaries thus enabling native speakers to translate your projects accurately and at a cheaper rate.

Translat3 has four functionalities

1. Add Project: This is used to add a project to the platform. Anyone can add project to the platform. User can write a short description and kickstart the project with a few funds.
2. Fund Project: After a project is added it can be funded by anybody in the community.
3. Translate: Once a project has enough funds, it can be moved to Translation phase, here translators from the community can translate the project, paragraph by paragraph.
4. Vote: If a paragraph has a valid translation, it can be voted by the community.

How are rewards distributed?

Each paragraph is given a value. For now, this value is Total Funds / No of Paragraphs. For each paragraph, the translator with valid translation is given 50% of the paragraph's value and the rest 50% is distributed among the rightful validators.

(back to top)

Built With

• Next.js 🔥
• Chakra UI ✨
• Rainbow Kit 🌈
• WAGMI Hooks 🔗
• Solidity
• Polygon 💜

(back to top)

How it Works?

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• yarn

Installation

1. Clone the repo

   git clone https://github.com/rakshit087/translat3

2. Install NPM packages

   yarn install

(back to top)

Usage

First start a local instance of HardHat Node:

  yarn hardhat node

Then deploy the smart contract by:

yarn hardhat run ".\src\hardhat\scripts\deploy.ts" --network localhost

Run the project using the following command:

   yarn run dev

If you face any error, try Resetting your Metamask Account for Hardhat.

(back to top)

Roadmap

• IPFS for storage.
• Biconomy for gasless transactions.
• Using zkProofs for calculating the distributions.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement" or "feature" Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Use the following branching structure for making contributions -

• Production deployment on main
• Dev deployment on dev
• Feature branches should be like feature/feature-name
• Bug fixes and patch branches should be like patch/patch-name
• Improvement to code branches should be like update/update-name

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

(back to top)

Acknowledgments

• Choose an Open Source License
• GitHub Emoji Cheat Sheet
• Img Shields
• GitHub Pages

(back to top)