{"id":23661392,"url":"https://github.com/BenjiFinance/BenjiAPIClient","last_synced_at":"2025-09-01T17:30:47.551Z","repository":{"id":270153690,"uuid":"885045019","full_name":"yesenvidnath/BenjiAPIClient","owner":"yesenvidnath","description":"This is the API client of the Benji Application this is the entier baceknd of the application","archived":false,"fork":false,"pushed_at":"2024-12-28T20:54:37.000Z","size":265,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-28T21:25:07.727Z","etag":null,"topics":["api-client","artisan","backend","js","laravel","microservices","mvc","php","postman","rest-api"],"latest_commit_sha":null,"homepage":"","language":"PHP","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/yesenvidnath.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":"2024-11-07T21:18:05.000Z","updated_at":"2024-12-28T20:10:12.000Z","dependencies_parsed_at":"2024-12-28T23:17:37.174Z","dependency_job_id":null,"html_url":"https://github.com/yesenvidnath/BenjiAPIClient","commit_stats":null,"previous_names":["yesenvidnath/benjiapiclient"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yesenvidnath%2FBenjiAPIClient","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yesenvidnath%2FBenjiAPIClient/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yesenvidnath%2FBenjiAPIClient/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yesenvidnath%2FBenjiAPIClient/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yesenvidnath","download_url":"https://codeload.github.com/yesenvidnath/BenjiAPIClient/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231701551,"owners_count":18413419,"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":["api-client","artisan","backend","js","laravel","microservices","mvc","php","postman","rest-api"],"created_at":"2024-12-29T04:57:33.816Z","updated_at":"2025-09-01T17:30:47.533Z","avatar_url":"https://github.com/yesenvidnath.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Benji API Client Backend Repository\n\nWelcome to the **Benji API Client Backend Repository**! This repository contains the complete backend implementation for the Benji Application, built using Laravel. It provides the core functionality and API endpoints required for the Benji ecosystem, integrating seamlessly with the frontend and admin modules.\n\n---\n\n## Project Overview\n\nThe Benji API Client serves as the backbone of the Benji ecosystem, managing data flow, business logic, and API endpoints. It powers features for user management, financial insights, authentication, and much more.\n\n### Key Features:\n- **User Management**: APIs for user registration, authentication, and role management.\n- **Financial Insights**: Endpoints for managing and analyzing financial data.\n- **Integration with Third-Party Services**: Seamless integration with payment gateways, Google APIs, and more.\n- **Secure Authentication**: Token-based authentication using Laravel Sanctum.\n- **Scalable Architecture**: Designed to handle large-scale applications.\n\n---\n\n## Project Structure\n\n### Key Directories:\n\n- **app/**: Core application logic and models.\n- **config/**: Configuration files for database, services, and other settings.\n- **database/**: Migrations, seeders, and factories for database setup.\n- **routes/**: API route definitions (web.php, api.php).\n- **resources/views/**: Laravel Blade templates for web rendering.\n- **storage/**: Logs, cached files, and compiled views.\n\n---\n\n## Requirements\n\n### Prerequisites:\nEnsure the following dependencies are installed:\n\n- PHP 8.1+\n- Composer\n- MySQL database\n- Laravel Framework 10.10\n- Node.js and npm (for asset management)\n- Redis (optional for caching and queue management)\n\n---\n\n## Environment Configuration\n\n### Setting Up the Environment:\nConfigure the `.env` file for your environment:\n\n```env\nAPP_NAME=BenjiAPI\nAPP_ENV=local\nAPP_KEY=base64:your_app_key_here\nAPP_DEBUG=true\nAPP_URL=http://localhost\n\nDB_CONNECTION=mysql\nDB_HOST=127.0.0.1\nDB_PORT=3306\nDB_DATABASE=benji_database\nDB_USERNAME=root\nDB_PASSWORD=your_password\n\nCACHE_DRIVER=file\nQUEUE_CONNECTION=sync\nSESSION_DRIVER=file\nSESSION_LIFETIME=120\n\nMAIL_MAILER=smtp\nMAIL_HOST=127.0.0.1\nMAIL_PORT=1025\nMAIL_USERNAME=null\nMAIL_PASSWORD=null\nMAIL_ENCRYPTION=null\nMAIL_FROM_ADDRESS=\"noreply@benji.com\"\nMAIL_FROM_NAME=\"Benji Support\"\n\nSANCTUM_STATEFUL_DOMAINS=localhost\n```\n\n---\n\n## Getting Started\n\n### Installation Steps:\n\n1. **Clone the Repository:**\n   ```bash\n   git clone https://github.com/yesenvidnath/BenjiAPIClient.git\n   cd BenjiAPIClient\n   ```\n\n2. **Install PHP Dependencies:**\n   ```bash\n   composer install\n   ```\n\n3. **Set Up Environment Variables:**\n   Create a `.env` file and configure it as described above.\n\n4. **Run Database Migrations and Seeders:**\n   ```bash\n   php artisan migrate --seed\n   ```\n\n5. **Serve the Application:**\n   ```bash\n   php artisan serve\n   ```\n\n6. **Set Up Storage:**\n   Link the storage directory for public access:\n   ```bash\n   php artisan storage:link\n   ```\n\n7. **Compile Frontend Assets (Optional):**\n   ```bash\n   npm install\n   npm run dev\n   ```\n\n---\n\n## API Endpoints\n\n### Authentication:\n- `POST /api/register`: Register a new user.\n- `POST /api/login`: Log in a user.\n- `POST /api/logout`: Log out the current user.\n\n### Financial Management:\n- `GET /api/expenses`: Retrieve user expenses.\n- `POST /api/expenses`: Add a new expense.\n- `PUT /api/expenses/{id}`: Update an expense.\n- `DELETE /api/expenses/{id}`: Delete an expense.\n\n### Admin Functions:\n- `GET /api/users`: Retrieve all users.\n- `POST /api/users`: Add a new user.\n- `DELETE /api/users/{id}`: Delete a user.\n\nFor detailed documentation, visit the [API Documentation](http://localhost/docs).\n\n---\n\n## Contribution Guidelines\n\nContributions are welcome! Please adhere to the following steps:\n\n1. Fork the repository and create a new branch for your feature or bugfix.\n2. Write clean, well-documented code.\n3. Test your changes thoroughly before submitting a pull request.\n4. Open a detailed pull request with a summary of your changes.\n\n---\n\n## License\n\nThis project is licensed under the MIT License. See the `LICENSE` file for details.\n\n---\n\n## Contact\n\nFor further inquiries or support:\n- **Name**: K.K.Y. Vidnath\n- **Email**: support@benji.com\n\nThank you for contributing to the Benji API Client!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBenjiFinance%2FBenjiAPIClient","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FBenjiFinance%2FBenjiAPIClient","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBenjiFinance%2FBenjiAPIClient/lists"}