{"id":22192517,"url":"https://github.com/3sidedcube/laravel-api-template","last_synced_at":"2025-07-26T22:32:10.778Z","repository":{"id":42081705,"uuid":"457272693","full_name":"3sidedcube/laravel-api-template","owner":"3sidedcube","description":"A template for creating new Laravel API projects.","archived":false,"fork":false,"pushed_at":"2023-03-13T17:00:25.000Z","size":462,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-04-14T02:42:50.420Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":false,"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/3sidedcube.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-02-09T08:31:35.000Z","updated_at":"2024-04-14T02:42:50.421Z","dependencies_parsed_at":"2022-08-12T04:20:57.289Z","dependency_job_id":null,"html_url":"https://github.com/3sidedcube/laravel-api-template","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3sidedcube%2Flaravel-api-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3sidedcube%2Flaravel-api-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3sidedcube%2Flaravel-api-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3sidedcube%2Flaravel-api-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/3sidedcube","download_url":"https://codeload.github.com/3sidedcube/laravel-api-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227726396,"owners_count":17810459,"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":"2024-12-02T12:25:43.082Z","updated_at":"2024-12-02T12:25:43.607Z","avatar_url":"https://github.com/3sidedcube.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://3sidedcube.com\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://3sidedcube.com/app/themes/tsc-2018/img/footer/logo-black.png\" width=\"400\" alt=\"3 Sided Cube\"\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n# :project_name\n\n\u003c!--delete--\u003e\n---\nThis repository can be used to scaffold new Laravel APIs. Follow these steps to get started: \n\n1. Run the following command in your terminal:\n```shell\ncomposer create-project 3sidedcube/laravel-api-template project-name -s dev\n```\n2. Next configure your Laravel services by running:\n```shell\nphp artisan sail:install\n```\n3. Update the `bitbucket-pipelines.yml` file to use any additional services \n4. Ensure that the provisioning and deployment information is correct\n5. Create a Backend API confluence page on the project space for writing helpful documentation (remember to update the README)\n6. Replace any references to project_name with your project name. You will need to update the following files:\n   1. `composer.json` (name)\n   2. README.md (title)\n   3. Environment variables (`.env`, `.env.example`, `.env.pipelines`)\n   4. OpenAPI (`v1.json`)\n   5. Changelog\n7. Update the environment information below with the correct URLs\n---\n\u003c!--/delete--\u003e\n\nThis is where your description should go. Limit it to a paragraph or two.\n\n## Environments\n\nThere are several environments available for this project.\n\n### Production\n\n[https://project-api.com](https://project-api.com)\n\nThis environment should only be used for production builds. Changes to the API should have been tested before they are\ndeployed to this environment.\n\n### Staging\n\n[https://project-api.com](https://project-api.com)\n\nOnce the API has completed internal testing, it should be deployed to this environment. This will then be used by the\nclient during UAT.\n\n\u003e Note: Please ensure that UAT always used this environment so that bug fixes and changes can be deployed to test\n\u003e whilst UAT is ongoing.\n\n### Test\n\n[https://project-api.com](https://project-api.com)\n\nThe test environment should be used for testing the API internally All mobile builds that are built for the testing\nteam should also point at this environment.\n\n### Development\n\n[https://project-api.com](https://project-api.com)\n\nThis environment is available for mobile developers or frontend developers to use when developing new features locally.\nIt is helpful to have the environment so that developers can fix any breaking changes before the API changes get\ndeployed to the test environment.\n\n## Local Development\n\nThis project uses Laravel Sail for local development which uses [Docker](https://www.docker.com/get-started). You will\nneed to ensure that you have Docker installed and running on your machine.\n\n### First time setup\n\n1. Copy the example environment file:\n```shell\ncp .env.example .env\n```\n\n2. Install Composer dependencies:\n```shell\ndocker run --rm \\\n    -u \"$(id -u):$(id -g)\" \\\n    -v $(pwd):/opt \\\n    -w /opt \\\n    laravelsail/php81-composer:latest \\\n    composer install --ignore-platform-reqs\n```\n\n3. Run the following commands:\n```shell\n./vendor/bin/sail up -d\n./vendor/bin/sail artisan key:generate\n./vendor/bin/sail artisan migrate\n./vendor/bin/sail artisan db:seed\n```\n\n4. The API should now be available at [http://localhost](http://localhost).\n\n### Stopping the project\n\n1. To stop the project docker containers, simply run the following command:\n```shell\n./vendor/bin/sail down\n```\n\n### Starting the project again\n\n1. To start the project docker containers after you've completed the first time use, simply run the following command:\n```shell\n./vendor/bin/sail up -d\n```\n\n### Gotchas\n\nHere are some helpful tips if you are having issues with this project:\n\n## Provisioning\n\nServer provisioning is handled by [Laravel Forge](https://forge.laravel.com).\n\n## Deployments\n\nTo deploy this project, login to [Envoyer](https://envoyer.io) and click deploy on the corresponding project.\n\n## Documentation\n\nAll documentation can be found under the following [page]() in confluence.\n\n## Logging\n\nWe use [Sentry](https://sentry.io) for keeping track of logs across the various environments.\n\n## Tests\n\nYou can run the full test suite by running the following command:\n\n```shell\nmake test\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3sidedcube%2Flaravel-api-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F3sidedcube%2Flaravel-api-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3sidedcube%2Flaravel-api-template/lists"}