Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
oliverbytes committed Sep 19, 2022
1 parent 0414709 commit 3e8ae84
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 72 deletions.
139 changes: 72 additions & 67 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,73 +6,77 @@
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![GPLv3 License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]



<!-- PROJECT LOGO -->
<br />
<p align="center">
<a href="https://github.com/liso-vault/app">
<img src="https://github.com/Liso-Vault/app/blob/master/assets/images/logo.png" alt="Logo" width="120" height="120">
</a>

<h1 align="center">Liso</h1>
<h1 align="center">Liso - Data Vault & Password Manager</h1>

<p align="center">
<a href="https://github.com/liso-vault/app/issues">Report Bug</a>
·
<a href="https://github.com/liso-vault/app/issues">Request Feature</a>
</p>

<h3 align="center">Decentralized & Open Source Password Manager</h3>
<p align="center">An open-source data management application that focuses mainly on securely storing private information and files. Think of 1Password, in a decentralized manner. Combined with a Crypto Wallet!</p>
</p>

<h3 align="center">Encrypted Private Vault & Password Manager in one</h3>
<p align="center">Protect your valuable data from prying eyes. Liso's secure data vault is the perfect place to keep passwords, files, and any other information you need to keep safe from unwanted people, hackers, and data leaks.</p>

<p align="center">Store any type of data: login credentials, passwords, email accounts, crypto wallets, seed phrases, 2FA / MFA, secure notes, debit/credit cards, bank accounts, medical records, driver's licenses, software licenses, social security numbers, and more.</p>
</p>

<!-- TABLE OF CONTENTS -->
## Table of Contents

* [About the Project](#about-the-project)
* [Built With](#built-with)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Usage](#usage)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
* [Contact](#contact)
* [Acknowledgements](#acknowledgements)
## Table of Contents

- [About the Project](#about-the-project)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
- [Acknowledgements](#acknowledgements)

## About The Project
Liso uses a powerful decentralized network of computers to route your files, making it impossible for anyone to leak or sell your data. You have the option to choose your provider: IPFS, Sia, Storj, and Skynet.

Zero-Knowledge: No phone number or email is needed to create a Liso Vault
Decentralized: Makes data breaches and central point of failures a thing of the past
No-Logging: Liso doesn't store, track, or log your data
Open-source: Check Liso's code yourself
Offline Mode: You have the choice to use the app 100% offline


Features
* Biometric Authentication
* Upload, Download, and Manage Files
* Seamlessly sync across multiple devices
* Multi-Vaults Support
* 2 Factor Item Protection
* Unlimited Devices
* Unlimited Items
* Export / Import Vault
Liso is not just a secure vault but also a great password manager and 2FA authenticator in one.

Features:
◆ Military-grade AES-256 Bit encryption
◆ Air-gapped / Offline mode
◆ Securely sync to multiple devices
◆ Self-hostable for 100% control
◆ Fingerprint/Face biometric authentication
◆ 2FA/MFA Authenticator
◆ Monitor weak passwords
◆ Password-protect items
◆ Protect your files with the built-in encryption tool
◆ Generate strong passwords
◆ Free private cloud storage for any file types
◆ Private photo and video storage with encryption
◆ Fill forms quickly with Auto Fill
◆ Also available for desktop, tablets, and mobile devices on other platforms
◆ Migrate from Bitwarden, LastPass, Chrome, Safari, and other browsers
◆ Powered by modern & secure Web3 technologies

Learn more: https://liso.dev

### Supported Platforms

- iOS
- Android
- MacOS
Expand All @@ -81,61 +85,63 @@ Features
- Web (soon)

### Built With
Google Flutter SDK
* [Flutter](https://flutter.dev)

Google Flutter SDK

- [Flutter](https://flutter.dev)

<!-- GETTING STARTED -->
## Getting Started

## Getting Started

### Prerequisites

* [Flutter SDK](https://flutter.dev)
* [Android SDK & Android Studio](https://developer.android.com/studio) for deployment to Android
* [XCode IDE](https://developer.apple.com/xcode/) for deployment to iOS/iPad/MacOS
* [VS Code IDE](https://code.visualstudio.com/) optional
- [Flutter SDK](https://flutter.dev)
- [Android SDK & Android Studio](https://developer.android.com/studio) for deployment to Android
- [XCode IDE](https://developer.apple.com/xcode/) for deployment to iOS/iPad/MacOS
- [VS Code IDE](https://code.visualstudio.com/) optional

### Installation

1. Clone the repo

```sh
git clone https://github.com/liso-vault/app.git
```

2. Install packages dependencies

```
flutter pub get
```

3. Run

```
flutter run
```
4. (To be updated)



4. (To be updated)

<!-- ROADMAP -->

## Roadmap

* Translations
* Autofill Service
* Breach Scanner
* Web3 Browser
* DeFi (Swap)
* Liso Token
* Liso DAO
* Liso Keycard - NFC Card to securely store your Wallet File
* Yubi Key Support
* Secure File Sharing
* E2EE Secure Messenger
- Translations
- Breach Scanner
- Web3 Browser
- DeFi (Swap)
- Liso Token
- Liso DAO
- Liso Keycard - NFC Card to securely store your Wallet File
- Yubi Key Support
- Secure File Sharing
- E2EE Secure Messenger

See the [open issues](https://github.com/liso-vault/app/issues) for a list of proposed features (and known issues).



<!-- CONTRIBUTING -->

## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
Expand All @@ -146,34 +152,33 @@ Contributions are what make the open source community such an amazing place to b
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request



<!-- LICENSE -->
## License

Distributed under the GPL v3 License. See `LICENSE` for more information.

## License

Distributed under the GPL v3 License. See `LICENSE` for more information.

<!-- CONTACT -->

## Contact

Oliver Martinez - [@oliverbytes](https://twitter.com/oliverbytes) - nemoryoliver@gmail.com (author)

Project Link: [https://github.com/liso-vault/app](https://github.com/liso-vault/app)



<!-- ACKNOWLEDGEMENTS -->

## Acknowledgements

(To be updated)

## Open-source Status
The current state of Liso being open-source is for self-auditing purposes only. This means some code are not included as they contain `secrets` proprietory for Liso as a business, in result you will be unable to successfully build the source.

The current state of Liso being open-source is for self-auditing purposes only. This means some code are not included as they contain `secrets` proprietory for Liso as a business, in result you will be unable to successfully build the source.

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->

[contributors-shield]: https://img.shields.io/github/contributors/liso-vault/app.svg?style=flat-square
[contributors-url]: https://github.com/liso-vault/app/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/liso-vault/app.svg?style=flat-square
Expand Down
2 changes: 1 addition & 1 deletion ios/Flutter/AppFrameworkInfo.plist
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@
<key>CFBundleVersion</key>
<string>1.0</string>
<key>MinimumOSVersion</key>
<string>9.0</string>
<string>11.0</string>
</dict>
</plist>
6 changes: 3 additions & 3 deletions ios/Runner.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,7 @@
GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
GCC_WARN_UNUSED_FUNCTION = YES;
GCC_WARN_UNUSED_VARIABLE = YES;
IPHONEOS_DEPLOYMENT_TARGET = 9.0;
IPHONEOS_DEPLOYMENT_TARGET = 11.0;
MTL_ENABLE_DEBUG_INFO = NO;
SDKROOT = iphoneos;
SUPPORTED_PLATFORMS = iphoneos;
Expand Down Expand Up @@ -461,7 +461,7 @@
GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
GCC_WARN_UNUSED_FUNCTION = YES;
GCC_WARN_UNUSED_VARIABLE = YES;
IPHONEOS_DEPLOYMENT_TARGET = 9.0;
IPHONEOS_DEPLOYMENT_TARGET = 11.0;
MTL_ENABLE_DEBUG_INFO = YES;
ONLY_ACTIVE_ARCH = YES;
SDKROOT = iphoneos;
Expand Down Expand Up @@ -510,7 +510,7 @@
GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
GCC_WARN_UNUSED_FUNCTION = YES;
GCC_WARN_UNUSED_VARIABLE = YES;
IPHONEOS_DEPLOYMENT_TARGET = 9.0;
IPHONEOS_DEPLOYMENT_TARGET = 11.0;
MTL_ENABLE_DEBUG_INFO = NO;
SDKROOT = iphoneos;
SUPPORTED_PLATFORMS = iphoneos;
Expand Down
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ dependencies:
secrets:
path: ../secrets
# alchemy_web3:
# git: https://github.com/oliverbytes/alchemy_web3.git
# git: https://github.com/oliverbytes/alchemy_web3.git
alchemy_web3:
git:
url: https://github.com/oliverbytes/alchemy_web3.git
Expand Down

0 comments on commit 3e8ae84

Please sign in to comment.