FlippyPass/README.md

# FlippyPass

A Password Manager for the Flipper-Zero

* [About this Project](#about-this-project)
* [Installing](#installing)
* [Building](#building)

## About this Project

This is a very simple Password Manager written in *C* for the Flipper Zero. The goal of this project is to allow anyone to use the flipper zero as their to go password manager!

This project was designed with simplicity and security in mind. All of your passwords **will** be safely encrypted and stored on your Flipper-Zero device.

## Installing

In order to Install this application, all you'll need to do is go to the [Releases Tab](https://git.objnull.net/objnull/FlippyPass/releases) on my Gitea instance and download the latest **.FAP** file. Place the file inside of: */SD Card/apps/tools*.

Launch the application, go through some basic setup options, and you're set for using the password manager!

## Migrating

If you are moving from a previous password manager, just want a backup, or something else, we support Importing & Exporting passwords!

Currently, we only accept **BitWarden JSON** exports.

Simply drag your export into your Flipper Zero's SD card, open FlippyPass, Navigate to Archive, Import, Select the file and watch the magic happen!

## Building

Currently, this project is developed using Docker, a fast container platform. I use docker as to not bloat my system with usless dependencies.

Make sure you have Docker installed. 

To build this project, just run `./scripts/docker.sh && ./scripts/build.sh` and you're all set! The *.fap* file will be placed in the *build/* directory.