{"id":24824569,"url":"https://github.com/gitericsson/raven_bank_api","last_synced_at":"2025-03-25T23:48:38.667Z","repository":{"id":274998103,"uuid":"924197020","full_name":"gitEricsson/Raven_Bank_API","owner":"gitEricsson","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-30T16:10:02.000Z","size":94,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-30T16:38:02.265Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gitEricsson.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-01-29T15:34:07.000Z","updated_at":"2025-01-30T16:10:06.000Z","dependencies_parsed_at":"2025-01-30T16:48:09.798Z","dependency_job_id":null,"html_url":"https://github.com/gitEricsson/Raven_Bank_API","commit_stats":null,"previous_names":["gitericsson/raven_bank_api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitEricsson%2FRaven_Bank_API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitEricsson%2FRaven_Bank_API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitEricsson%2FRaven_Bank_API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitEricsson%2FRaven_Bank_API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gitEricsson","download_url":"https://codeload.github.com/gitEricsson/Raven_Bank_API/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245563039,"owners_count":20635907,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-30T20:56:30.328Z","updated_at":"2025-03-25T23:48:38.646Z","avatar_url":"https://github.com/gitEricsson.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Raven Money Transfer API\n\nA RESTful API for managing user accounts, transactions, and webhooks for a money transfer application. Built with TypeScript, Express, and Knex.js.\n\n## Table of Contents\n\n- [Features](#features)\n- [Technologies](#technologies)\n- [Installation](#installation)\n- [Configuration](#configuration)\n- [Usage](#usage)\n- [API Documentation](#api-documentation)\n- [Testing](#testing)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Features\n\n- User registration and authentication\n- Account creation and management\n- Transaction handling (deposit and transfer)\n- Webhook handling for transaction status updates\n- Rate limiting and security middleware\n- Swagger documentation for API endpoints\n\n## Technologies\n\n- **Node.js**: JavaScript runtime\n- **Express**: Web framework for Node.js\n- **TypeScript**: Superset of JavaScript for type safety\n- **Knex.js**: SQL query builder for database interactions\n- **MySQL**: Relational database management system\n- **Joi**: Data validation library\n- **Winston**: Logging library\n- **Swagger**: API documentation\n\n## Installation\n\n1. Clone the repository:\n\n   ````bash\n   git clone https://github.com/yourusername/money-transfer-app.git\n   cd money-transfer-app\n   ```README.md\n\n   ````\n\n2. Install dependencies:\n\n   ```bash\n   npm install\n   ```\n\n3. Set up your environment variables:\n   - Copy `.env.example` to `.env` and update the values as needed.\n\n## Configuration\n\n### Environment Variables\n\nMake sure to configure the following environment variables in your `.env` file:\n\n```plaintext:README.md\nDB_HOST=localhost\nDB_USER=root\nDB_PASSWORD=\nDB_NAME=money_transfer\nJWT_SECRET=your-secret-key\nJWT_EXPIRY=1h\nREFRESH_TOKEN_SECRET=refresh-secret-key\nREFRESH_TOKEN_EXPIRY=7d\nPORT=3000\nBASE_URL=http://localhost:3000\nRAVEN_API_URL=https://integrations.getravenbank.com/v1\nRAVEN_API_KEY=your-raven-api-key\nRAVEN_WEBHOOK_SECRET=your-webhook-secret\nNODE_ENV=development\n```\n\n## Usage\n\n1. Start the server:\n\n   ```bash\n   npm run dev\n   ```\n\n2. Access the API at `http://localhost:3000`.\n\n3. View the API documentation at `http://localhost:3000/api-docs`.\n\n## API Documentation\n\n### User Management\n\n- **POST /api/users/register**: Register a new user.\n- **POST /api/users/login**: Log in a user.\n- **POST /api/users/refresh-token**: Refresh access token.\n\n### Account Management\n\n- **POST /api/accounts**: Create a new account.\n- **GET /api/accounts**: Get all accounts for the authenticated user.\n- **GET /api/accounts/all**: Get all accounts (admin only).\n\n### Transaction Management\n\n- **POST /api/transactions/transfer**: Transfer money between accounts.\n- **GET /api/transactions/history/:accountNumber**: Get transaction history for an account.\n\n### Webhook Management\n\n- **POST /api/webhooks**: Handle incoming deposit webhooks.\n- **GET /api/webhooks/logs**: Get webhook logs (admin only).\n\n## Testing\n\nRun tests using Jest:\n\n```bash\nnpm test\n```\n\n## Contributing\n\nContributions are welcome! Please open an issue or submit a pull request.\n\n## License\n\nThis project is licensed under the MIT License.\n\n```\n\n### Instructions to Use the README\n- Replace `yourusername` in the clone URL with your actual GitHub username.\n- Update any specific details related to your project as necessary.\n- Ensure that the API documentation matches the actual endpoints and functionality of your application.\n\nWould you like to add any additional sections or modify any part of this README?\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitericsson%2Fraven_bank_api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgitericsson%2Fraven_bank_api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitericsson%2Fraven_bank_api/lists"}