keeweb/README.md

37 lines
1.6 KiB
Markdown
Raw Normal View History

2015-10-17 23:49:24 +02:00
# KeePass web app (unofficial)
This webapp can read KeePass databases. It doesn't require any server or additional resources.
2015-10-25 09:06:04 +01:00
It can be run either in browser, or as a desktop app.
2015-10-17 23:49:24 +02:00
2015-11-04 07:30:01 +01:00
![screenshot](https://habrastorage.org/files/bfb/51e/d8d/bfb51ed8d19847d8afb827c4fbff7dd5.png)
2015-10-18 00:16:23 +02:00
2015-10-25 09:06:04 +01:00
# Quick Links
2015-10-17 23:49:24 +02:00
2015-10-31 23:01:24 +01:00
Web: [Web App](https://antelle.github.io/keeweb/)
2015-11-04 07:58:18 +01:00
Desktop: [Windows](https://github.com/antelle/keeweb/releases/download/v0.1.1/KeeWeb.win32.exe)
[Mac OSX](https://github.com/antelle/keeweb/releases/download/v0.1.1/KeeWeb.mac.dmg)
[Linux](https://github.com/antelle/keeweb/releases/download/v0.1.1/KeeWeb.linux.x64.zip)
2015-10-31 23:20:00 +01:00
Timeline: [Release Notes](release-notes.md)
[TODO](TODO.md)
On one page: [Features](features.md)
2015-10-22 07:38:08 +02:00
2015-10-25 09:06:04 +01:00
# Status
2015-10-22 07:38:08 +02:00
2015-10-25 09:06:04 +01:00
Reading and display is mostly complete; modification and sync is under construction, please see [TODO](TODO.md) for more details.
2015-10-25 09:25:48 +01:00
# Building
2015-10-25 09:27:09 +01:00
The app can be built with grunt: `grunt` (html file will be in `dist/`) or `grunt watch` (result will be in `tmp/`).
2015-10-25 09:25:48 +01:00
Electron app is built manually, scripts and configs are in `util` directory.
2015-10-25 09:27:09 +01:00
To run Electron app without building, install electron package (`npm install electron-prebuilt -g`) and start with `electron ./electron/`.
2015-10-25 09:25:48 +01:00
# Contributing
Plugins are not supported for now. If you want to add a feature, please contact the author first. Pull requests, patches and issues are very welcome.
If you have found an bug, please [open an issue](https://github.com/antelle/keeweb/issues/new) and fill in the app version and your user-agent
(you can find these details on Settings/Help section).
# License
[MIT](https://github.com/antelle/keeweb/blob/master/MIT-LICENSE.txt)