Skip to content

jinosfinance/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 

Repository files navigation

JinOS Documentation

Repository License Documentation

Official documentation repository for JinOS — the first AI-managed neobank on BNB Smart Chain

📖 Overview

This repository contains the complete public documentation for JinOS, a decentralized neobank agent built on BNB Smart Chain (BSC). JinOS combines self-custodial wallets, virtual Visa cards, and AI-powered financial management in a premium glassmorphism interface.

Key Features

  • Self-Custodial Wallet: MPC-based wallet creation via Privy
  • Virtual Cards: Instant Visa debit cards funded from your BSC wallet
  • AI Financial Agent: 24/7 automated portfolio management and spend analysis
  • Real-Time BSC Data: Live market data, gas prices, and network status
  • Premium UI: Glassmorphism design with real-time BSC integration

🚀 Quick Start

For Users

  1. Visit jinos.xyz
  2. Sign in with email OTP
  3. Get your embedded BSC wallet automatically
  4. Issue virtual cards and start using JinOS

For Developers

  1. Clone this repository:
    git clone https://github.com/jinosfinance/docs.git
    cd docs
  2. Navigate to documentation:
    cd docs/
  3. Open any .md file to read the guides

📚 Documentation Structure

docs/
├── README.md              # Main documentation index
├── getting-started.md     # User onboarding guide
├── architecture.md        # System design & tech stack
├── api-reference.md       # Complete REST API docs
├── security.md           # Security model & MPC details
├── faq.md                # Frequently asked questions
└── structure.md          # Repository structure details

Core Guides

Guide Description
Getting Started Complete user onboarding
Architecture Technical system overview
API Reference Full endpoint documentation
Security Non-custodial security model
FAQ Common questions & answers

🛠️ Technology Stack

  • Frontend: React 19 + Vite 7 + TypeScript
  • Backend: Node.js + Express 5 + TypeScript
  • Database: PostgreSQL + Drizzle ORM
  • Blockchain: BNB Smart Chain (BSC Mainnet)
  • Auth: Privy MPC (Multi-Party Computation)
  • Documentation: Markdown with GitHub Pages

🤝 Contributing

We welcome contributions to improve the JinOS documentation!

How to Contribute

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/your-feature
  3. Make your changes to the documentation files
  4. Test your changes by reading through the updated content
  5. Commit your changes: git commit -m 'Add detailed API examples'
  6. Push to the branch: git push origin feature/your-feature
  7. Open a Pull Request

Guidelines

  • Use clear, concise language
  • Include code examples where helpful
  • Update the table of contents if adding new sections
  • Test all links and references
  • Follow Markdown best practices

Reporting Issues

Found an error or have a suggestion? Open an issue on GitHub.

📄 License

This documentation is licensed under the MIT License - see the LICENSE file for details.

🔗 Links

📞 Support

  • Documentation Issues: Open an issue in this repository
  • Application Support: Visit jinos.xyz and use the in-app support
  • Community: Follow @JinOS_Fi for updates

JinOS - AI-managed neobank on BNB Smart Chain. Non-custodial, secure, and intelligent financial management.

About

No description, website, or topics provided.

Resources

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors