Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flowstake/.github
Flowstake - Activity Network Documention
https://github.com/flowstake/.github
documentation
Last synced: about 1 month ago
JSON representation
Flowstake - Activity Network Documention
- Host: GitHub
- URL: https://github.com/flowstake/.github
- Owner: flowstake
- Created: 2024-06-26T20:41:10.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-07-27T17:55:40.000Z (5 months ago)
- Last Synced: 2024-07-27T19:12:51.067Z (5 months ago)
- Topics: documentation
- Size: 15.6 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FlowStake
FlowStake is an innovative platform designed to capture and record proof of physical activities as stakes, utilizing blockchain technology to ensure transparency and reliability. The platform supports activities such as running and cycling, and integrates various features to provide a comprehensive user experience.
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## Introduction
FlowStake aims to revolutionize how physical activities are tracked and verified. By using a distributed ledger, we ensure that each activity is recorded securely and transparently. Our platform provides a social network-like experience where users can interact, compete, and attest to each other's activities.
## Features
- **Activity Tracking**: GPS and heartbeat data tracking for running and cycling.
- **Attestation**: Peer-to-peer attestation and photo/video verification of activities.
- **Social Interaction**: Activity feed, friend interactions, and collective attestations.
- **Blockchain Integration**: Permanent records stored on Hedera Hashgraph and Ethereum smart contracts for self-sports betting.
- **Account Management**: Secure login and account management using web3auth.io.
- **Progressive Web App**: Live data capture and mobile compatibility for iOS and Android.
## Technologies Used
- **Frontend**: React Native with Expo SDK 46
- **Backend**: Firebase for data storage
- **Blockchain**: Hedera Hashgraph and Ethereum smart contracts
- **Authentication**: web3auth.io
- **Hosting**: IPFS (InterPlanetary File System)
- **Miscellaneous**: Computer vision for activity identification
## Installation
To get started with FlowStake, follow these steps:
1. Clone the repository:
```sh
git clone https://github.com/yourusername/flowstake.git
```
2. Navigate to the project directory:
```sh
cd flowstake/expo
```
3. Install dependencies:
```sh
npm install
```
4. Start the development server:
```sh
expo start
```
## Usage
1. Sign up or log in using web3auth.io.
2. Start tracking your activities using the GPS and heartbeat data features.
3. Verify activities through photo/video attestation and peer-to-peer attestation.
4. Interact with friends through the activity feed and participate in self-sports betting using Ethereum smart contracts.
## Contributing
We welcome contributions from the community. To contribute:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature/your-feature`).
3. Make your changes.
4. Commit your changes (`git commit -m 'Add some feature'`).
5. Push to the branch (`git push origin feature/your-feature`).
6. Open a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Contact
For any inquiries or issues, please contact us at [email protected].
---
Feel free to modify or expand this README as needed. Let me know if you need any additional sections or details!