Keychi

Keychi is the best password manager for securely storing, managing data such as passwords, passkeys, OTP and credit cards.

🚀 Getting Started

Setup environment / start containers

yarn docker:up

# Stop containers
yarn docker:down

Migrate database

To create tables, copy/paste api/migration/db.sql into pgadmin query editor and execute it.

Development

# Start keychi api server (Golang)
# Install swaggo cli for generating api docs (if not installed)
go install github.com/swaggo/swag/cmd/swag@latest

# Install gow cli for watching file changes and restart server (if not installed)
go install github.com/mitranim/gow@latest

yarn api:dev

# Start keychi web app
yarn web:dev

# Start keychi mobile app

# Start keychi desktop app

Accessing resources

• Minio console: http://localhost:9000
• Postgres server: http://localhost:5432
• Keycloak: http://localhost:8080
• Keychi web: http://localhost:8888
• Keychi API: http://localhost:3000/api/v1/docs/index.html

🐥 Documentation

• Notion
• Figma
• System Architecture

📎 References

• Photphor Iconify

---

Created at: 06-10-2024