Add files via upload

Author: DefinetlyNotAI

Old banking website/v0.1/README.md

@@ -0,0 +1,99 @@
+# Hackathon Banking API
+
+A ready-to-use banking API server for hackathon projects. This Flask-based API provides a comprehensive set of features
+for managing virtual currencies, wallets, and transactions.
+
+## Features
+
+- **Bank/Currency Management**
+    - Setup new bank/currency name
+    - Configure bank rules
+    - Mint and burn currency
+
+- **Wallet Operations**
+    - Create new wallets
+    - View wallet balances
+    - Freeze, unfreeze, or burn wallets
+    - Reset wallet balances
+
+- **Transaction Processing**
+    - Currency transfers with idempotency support
+    - Transaction categorization
+    - Transaction approval workflow
+    - Refund requests
+
+- **Role-Based Access Control**
+    - Admin, User, and Guest roles
+    - Proper permission enforcement
+
+- **Reporting**
+    - Public transaction logs
+    - Private user logs
+    - Audit logs for admin actions
+    - Wallet leaderboard
+
+- **User Management**
+    - Password reset requests
+    - User authentication
+
+## Getting Started
+
+### Prerequisites
+
+- Python 3.8 or higher
+- PostgreSQL database
+- Git
+
+### Installation
+
+1. Clone the repository:
+   \`\`\`
+   git clone https://github.com/yourusername/hackathon-banking-api.git
+   cd hackathon-banking-api
+   \`\`\`
+
+2. Create a virtual environment:
+   \`\`\`
+   python -m venv venv
+   source venv/bin/activate # On Windows: venv\Scripts\activate
+   \`\`\`
+
+3. Install dependencies:
+   \`\`\`
+   pip install -r requirements.txt
+   \`\`\`
+
+4. Set up environment variables:
+   Create a .env file in the root directory with:
+   \`\`\`
+   POSTGRESQL_DB_URL=postgresql://username:password@localhost:5432/banking_db
+   JWT_SECRET=your_jwt_secret_key
+   FLASK_ENV=development
+   \`\`\`
+
+5. Initialize the database:
+   \`\`\`
+   flask db init
+   flask db migrate -m "Initial migration"
+   flask db upgrade
+   \`\`\`
+
+6. Create an admin user:
+   \`\`\`
+   flask create-admin --username admin --password secure_password
+   \`\`\`
+
+7. Run the server:
+   \`\`\`
+   flask run
+   \`\`\`
+
+The API will be available at http://localhost:5000
+
+## API Documentation
+
+For detailed API documentation, see the [API Documentation](https://your-deployed-app.com/api-docs) page.
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.