Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Add documentation section to the readme files. #42

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+24 −7
Open

[docs] Add documentation section to the readme files. #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@

<a href="https://x.com/RevoFarmers">
<img src="https://img.shields.io/twitter/follow/RevoFarmers?style=social"/>
</a>
<img src="https://img.shields.io/github/stars/Crypto-Jaguars/Revolutionary_Farmers?style=social"/>


[![Telegram Chat][tg-badge]][tg-url]

[tg-badge]: https://img.shields.io/endpoint?color=neon&logo=telegram&label=chat&style=flat-square&url=https%3A%2F%2Ftg.sumanjay.workers.dev%2FRevolutionary_Farmers
Expand All @@ -29,7 +27,6 @@ This project was created and initiated during the [Ethereum Pura Vida 2024](http
## 🗂️ Project Structure

- **android**: An Android Studio app where users can approve trust transactions using the Zero-Knowledge Ring ([Zero-Knowledge Ring](https://www.zero-knowledge-ring.com/)) for privacy-focused transaction validation. This app also connects to the Trustless Work API to manage escrow-based approvals.

- **contracts**: Blockchain smart contracts (under development) that will support decentralized management of the trusts, providing a transparent and secure solution for crop financing.

- **frontend**: A Next.js application where farmers can request trusts via the Trustless Work API. This interface allows farmers to access the platform securely and manage their requests for escrow-backed financing.
Expand Down Expand Up @@ -102,9 +99,14 @@ Each folder within the project (`android`, `contracts`, `frontend`) contains its

We welcome contributions! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to this project.

## 📄 Documentation

> All active development for this project happens on the `dev` branch. To contribute effectively, please ensure your changes work as intended on this branch before submitting a pull request. Pull requests should always target the `dev` branch for proper testing and review before merging into the `main` codebase. Please **DO NOT** submit pull requests directly to the `main` branch.

## 📝 Testing our Frontend

Please see our [TEST.md](web/TEST.md) for details on how to successfully test our frontend.

## 📜 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
13 changes: 10 additions & 3 deletions android/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,14 @@ The project is located in the `android` folder and is developed using Android St
## 📝 Prerequisites

### Minimum Hardware Requirements:

- Operating System: Windows (8, 10, or 11) / Linux / macOS (10.14 Mojave or later) / ChromeOS.
- RAM: 8 GB (16 GB recommended)
- Storage: 4 GB of free space for Android Studio and dependencies.
- CPU: 64-bit processor (Intel or AMD).

### Software Requirements:

- [Android Studio](https://developer.android.com/studio): Version 4.0 or higher.
- [JDK](https://www.oracle.com/java/technologies/javase-downloads.html): Version 8 or higher.
- An Android device or a configured emulator
Expand All @@ -40,20 +42,21 @@ Follow these steps to set up the project on your local machine:
```

Then, open the project in Android Studio:
- Launch **Android Studio**.

- Launch **Android Studio**.
- Click on “Open an existing Android Studio project”.
- Select the `android` folder from the cloned repository.

3. **Configure Dependencies**

Configure Dependencies

```bash
implementation 'com.ringofrings:ringofringssdk:latest_version'
```

Check the Ring of Rings SDK repository (https://github.com/ringofrings/ringofringssdk) for the latest version.


4. **Configure the Trustless Work API**

Follow the [Trustless Work documentation](https://docs.trustlesswork.com/trustless-work) to correctly integrate the API into your application. Make sure to have all the necessary credentials and configurations, such as API keys and corresponding endpoints.
Expand All @@ -71,9 +74,13 @@ Once you have installed and configured the project, follow these steps to run an
- **Reject Trusts:** If necessary, you can also reject trusts by following the designated workflow.
- **Verify Contracts:** You can review the status of trust contracts from the interface.

## 📄 Documentation

> All active development for this project happens on the `dev` branch. To contribute effectively, please ensure your changes work as intended on this branch before submitting a pull request. Pull requests should always target the `dev` branch for proper testing and review before merging into the `main` codebase. Please **DO NOT** submit pull requests directly to the `main` branch.

## 🛠 Tech Stack

- **[Android SDK](https://developer.android.com/studio)** - Framework for building Android applications.
- **[Kotlin](https://kotlinlang.org/)** - Programming language for building Android apps.
- **[Ring of Rings SDK](https://github.com/ringofrings/ringofringssdk)** - SDK for integrating ring-based identity and access management in Android applications.
- **[Trustless Work API](https://docs.trustlesswork.com/trustless-work)** - Enables trustless payments via smart contracts, securing funds in escrow until milestones are approved by clients.
- **[Trustless Work API](https://docs.trustlesswork.com/trustless-work)** - Enables trustless payments via smart contracts, securing funds in escrow until milestones are approved by clients.
4 changes: 4 additions & 0 deletions contracts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@

# ¡Coming soon...!

## 📄 Documentation

> All active development for this project happens on the `dev` branch. To contribute effectively, please ensure your changes work as intended on this branch before submitting a pull request. Pull requests should always target the `dev` branch for proper testing and review before merging into the `main` codebase. Please **DO NOT** submit pull requests directly to the `main` branch.
4 changes: 4 additions & 0 deletions web/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ Available Commands:
- `npm run lint` - Run ESLint linter
- `npm run format` - Format code with Prettier

## 📄 Documentation

> All active development for this project happens on the `dev` branch. To contribute effectively, please ensure your changes work as intended on this branch before submitting a pull request. Pull requests should always target the `dev` branch for proper testing and review before merging into the `main` codebase. Please **DO NOT** submit pull requests directly to the `main` branch.

## 🛠 Tech Stack

- [Next.js](https://nextjs.org) (v14.2.14) - React framework
Expand Down