This repository has been archived by the owner on Jul 5, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1,005 changed files
with
1,133 additions
and
11,386 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
# Contributing with TIKI | ||
|
||
Thanks for contributing with Tiki! | ||
|
||
The following is a set of guidelines for contributing to TIKI and its packages, which are hosted in the [TIKI Organization](https://github.com/tiki) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. | ||
|
||
### Asking questions | ||
|
||
Please don't use the repositories issues to ask/answer questions. We have a direct channel with our users through [Tiki's Public Discord](https://discord.com/invite/evjYQq48Be). You are welcome to join our server and ask all your questions there! | ||
|
||
### Reporting Bugs | ||
To report a bug, please [file an issue](https://github.com/tiki/app/issues/new) containing the following information: | ||
**Device model and OS version**: [Check in iOS](https://support.apple.com/en-us/HT201685) / [Check in Android](https://support.google.com/android/answer/7680439?hl=en) | ||
**App version:** It can be found in Appstore/Playstore or in the end of the app's user modal. | ||
**Description:** The description of the error. What did not happen that should and/or what happened that shouldn't. | ||
**Steps to Reproduce:** Detailed steps to reproduce the bug. | ||
**Expected Result:** What should be the expected behavior without the bug. | ||
|
||
### Suggesting Enhancements | ||
Before opening an issue with enhancements suggestions, please discuss it with us in [Tiki's Public Discord](https://discord.com/invite/evjYQq48Be). | ||
|
||
### Contribute with code | ||
To contribute with code you should follow these steps: | ||
1. Fork the repository. | ||
2. Create a branch out of develop. If it is related to a issue from the original repository, start the branch name with the # symbol followed by the issue number. | ||
3. Write the code, commit and merge into your develop branch and make sure it builds, all the warnings are resolved and all tests passes. | ||
4. Create a Pull Request from your branch to the original repository, describing which changes your code did. | ||
5. Wait for code review and apply any requested changes. | ||
|
||
### Test guidelines | ||
We encourage you to write automated tests to all the code you write, but it is just required to have automated tests for publicly available APIs. | ||
|
||
Before creating a Pull Request you should write at least one test case that describes what the code do and how to test it. | ||
|
||
Sometimes the code have too much third party integrations that makes it hard to add automated tests. If that's the case don't bother mocking up code. Use a manual test scenario and add a screencapture of it. | ||
|
||
Refer to [Flutter Integration Tests Documentation](https://docs.flutter.dev/testing/integration-tests) for writing integration tests. | ||
|
||
### Documentation guidelines | ||
In TIKI we believe that the code should be self explanatory for any tech reader. | ||
|
||
Avoid using comments to explain what you are doing. If one can't understand reading the code, it should be rewritten. | ||
|
||
But in an open source project, one should not need to read all the code to understand which public APIs to use. That's where we need in-code documentation. | ||
|
||
You don't need to document all and every line of code, class, top level methods and properties. If you want, that's ok, but not required. | ||
|
||
It is required to document all and every publicly available APIs that will be used by others to interact with the code. | ||
|
||
To document the code follow [Dart Documentation Guidelines](https://dart.dev/guides/language/effective-dart/documentation#doc-comments). | ||
|
||
### Styleguides | ||
- Name all the files, classes, methods, functions and variables in english with a self-explanatory name. | ||
- For filenames use snake_case. | ||
- For classes use PascalCase. | ||
- For variables and functions use camelCase. | ||
- Use one file for each class. The filename should be the class name. | ||
- Groups files first by what feature they implement, using the slice architecture. Inside each slice, group the files by role. | ||
- Avoid creating a folder if it will hold just one or two files. | ||
- Use local imports always when possible. | ||
- For Flutter code use [flutter_lints](https://pub.dev/packages/flutter_lints) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,55 +1,59 @@ | ||
# Tiki App | ||
|
||
*We’re all users and in it together.* | ||
|
||
**No** secrets. **Real** transparency. **Open source** by design. | ||
|
||
Everything that we do in our app is here. And you are welcome to explore it and contribute. | ||
|
||
----- | ||
#### Our Mission | ||
|
||
We’re building a fair, user-centric, decentralized system, giving the users control of their data. | ||
It’s **your** data; you deserve the right to see, control, and monetize it. Your data does not belong to corporations, **TIKI included**! | ||
We build tools to protect users from exploitation, greed, and carelessness. We build tools to **empower** users. | ||
|
||
#### Our values | ||
- **TRANSPARENCY** helps build trust. Seeing is believing, and nothing is off-limits. No shadowbans or secret algorithms at TIKI. | ||
- **COMMUNITY** is what connects us. Together, we're an unstoppable force. We expect better. We demand better. | ||
- **DIVERSITY** is not optional within the walls of TIKI. We're here for our users; we represent our users | ||
- **SUSTAINABILITY** comes before profit. We work tirelessly to bring lasting positive change to our users' lives. | ||
- **RELIABILITY** is foundational to trust. We want our users to count on us and aim never to break that trust. | ||
|
||
----- | ||
## Contributing | ||
|
||
1. [Join our Discord](https://discord.com/invite/evjYQq48Be), meet the community and help us in giving back people the control of their data. | ||
2. [Create an issue](https://github.com/tiki/app/issues/new/choose) if you find a bug or would like to ask for a feature, | ||
3. [Fork this repository](https://github.com/tiki/app/fork) to contribute with code and send us a Pull Request. | ||
|
||
## About Tiki | ||
### It's **your** data. Get **paid** for it | ||
|
||
Your data is worth thousands a year. Why aren’t you getting your fair share? Take back control. Get paid. | ||
|
||
**Tiki’s got your back.** | ||
|
||
Why TIKI? | ||
You think you own your data? | ||
In 2020 alone, the data on our behaviour and purchases was worth more than $382 billion in advertising revenue. | ||
|
||
### How does it work? | ||
|
||
Link your accounts to the TIKI app and we'll get you paid your fair share. | ||
|
||
|
||
1. **See** what data companies are collecting on you, how its used, and how secure it really is. | ||
|
||
2. **Control** who has access to your data and for what purpose. It’s your decision. | ||
|
||
3. **Monetize** Get paid your fair share for granting buyers access to your data. | ||
|
||
## Contact Us | ||
Follow us, tweet us, hit us up. Together we're a revolution. | ||
|
||
[Twitter](https://twitter.com/my_tiki_) - [Instagram](https://www.instagram.com/my.tiki/) - [Facebook](https://www.facebook.com/mytikiapp) - [Tiktok](https://www.tiktok.com/@my.tiki?) - [LinkedIn](https://www.linkedin.com/company/mytiki/) - [Discord](https://discord.com/invite/evjYQq48Be) - [Telegram](https://t.me/mytikiapp) - [Signal](https://signal.group/#CjQKIA66Eq2VHecpcCd-cu-dziozMRSH3EuQdcZJNyMOYNi5EhC0coWtjWzKQ1dDKEjMqhkP) | ||
# TIKI App | ||
The TIKI app is the tool for user data ownership. | ||
|
||
With TIKI App the users can have insights of who is using their data, manage the access to it, collect their own data, anonymize and sell it (or do whatever they want!). | ||
|
||
[Why is TIKI open source?](https://blog.mytiki.com/p/real-transparency-is-powerfu) | ||
|
||
## How to Install | ||
|
||
TIKI app is built with [Flutter](https://flutter.dev). | ||
|
||
1. [Install Flutter](https://docs.flutter.dev/get-started/install) | ||
2. Clone this repository. | ||
3. [Configure Firebase in your Flutter Project](https://firebase.google.com/docs/flutter/setup?platform=ios) | ||
4. Go to app's root directory. | ||
5. Get pub dependencies - `flutter pub get`. | ||
6. Run the app | ||
-- production mode: `flutter run`. | ||
-- development mode: `flutter run --dart-define=com.mytiki.app.environment=develop` | ||
|
||
## Code structure | ||
|
||
In TIKI we use the [vertical slice architecture](https://jimmybogard.com/vertical-slice-architecture/) to organize the code. | ||
|
||
Each feature is developed in a [Flutter Package or Plugin](https://docs.flutter.dev/development/packages-and-plugins/using-packages) in its own repository. | ||
|
||
The app code is responsible for initializing the Home Screen, the packages and plugins with the other features, and to implement the Data Slice. | ||
|
||
|
||
Currently TIKI App is made with the following libs. | ||
| Library | Description| | ||
|--|--| | ||
| [login](https://github.com/tiki/login) | Handles user login flow and user keys management. | ||
| [money](https://github.com/tiki/money) | Manages the "money" screen. | ||
| [decision](https://github.com/tiki/decision) | Manages the "decision" screen. | ||
| [user_account](https://github.com/tiki/user_account) | User account menu bottom sheet UI. | ||
| | | ||
| [spam_cards](https://github.com/tiki/spam_cards) | TIKI Spam Cards UI. | ||
| [info_carousel](https://github.com/tiki/info_carousel) | TIKI info cards UI. | ||
| | | ||
| [tiki_kv](https://github.com/tiki/tiki_kv) | Simple encrypted database Key-value storage. | ||
| [style](https://github.com/tiki/style) | TIKI Style library. | ||
| | | ||
| [httpp](https://github.com/tiki/httpp) | HTTP Parallel requests handling with Dart. | ||
| [microsoft_provider](https://github.com/tiki/microsoft_provider) | API for Microsoft (Outlook) data fetching. | ||
| [google_provider](https://github.com/tiki/google_provider) | API for Google (Gmail) data fetching. | ||
| | | ||
| [localchain](https://github.com/tiki/localchain) | TIKI's localized mobile blockchain (dart native). | ||
| [syncchain](https://github.com/tiki/syncchain) | Mobile side implementation of TIKI's sync chain for backing up local chains. | ||
| [wallet](https://github.com/tiki/wallet) | Very simple wallet for managing crypto keys. | ||
| [localgraph](https://github.com/tiki/localgraph) | Mobile side implementation of Knowledge Graph Service. | ||
| | | ||
| [zendesk_flutter](https://github.com/tiki/zendesk_flutter) | TIKI Zendesk Help Center inside the app. | ||
| [upvoty](https://github.com/tiki/upvoty) | In-app user feedback. | ||
|
||
## How to contribute | ||
Thank you for contributing with the data revolution! | ||
All the information about contribution can be found in [CONTRIBUTING](https://github.com/tiki/app/CONTRIBUTING.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
include: package:flutter_lints/flutter.yaml | ||
|
||
linter: | ||
rules: | ||
prefer_relative_imports: true | ||
prefer_relative_imports: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.