{"id":22192563,"url":"https://github.com/3sidedcube/buhackathonapi","last_synced_at":"2025-09-19T11:48:04.617Z","repository":{"id":79436439,"uuid":"538712410","full_name":"3sidedcube/BUHackathonAPI","owner":"3sidedcube","description":null,"archived":false,"fork":false,"pushed_at":"2022-09-22T14:22:50.000Z","size":65,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-03T17:29:28.576Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-09-19T22:01:19.000Z","updated_at":"2022-09-22T09:56:03.000Z","dependencies_parsed_at":null,"dependency_job_id":"9c3f0046-db15-43fc-ac8e-a417118cb02b","html_url":"https://github.com/3sidedcube/BUHackathonAPI","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"ZakFarmer/laravel-api-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3sidedcube%2FBUHackathonAPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3sidedcube%2FBUHackathonAPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3sidedcube%2FBUHackathonAPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3sidedcube%2FBUHackathonAPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/3sidedcube","download_url":"https://codeload.github.com/3sidedcube/BUHackathonAPI/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3sidedcube%2FBUHackathonAPI/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":258990554,"owners_count":22789100,"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:26:15.212Z","updated_at":"2025-09-19T11:47:59.580Z","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# BU Hackathon Impact API\n\n## Environments\n\nThe main environment can be found at [https://bu-hackathon-api.herokuapp.com/api/v1](https://bu-hackathon-api.herokuapp.com/api/v1)\n\n## Documentation\n\nThe documentation for the API can be found [here](https://bu-hackathon-api.herokuapp.com/api/v1/docs).\n\nFor a little background and some direction for using the API, you can read an introduction [here](https://bu-hackathon.cubeapis.com).\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## Deployments\n\nThe API is deployed using a free Heroku dyno. You can use Heroku or a similar service to deploy your own API at zero cost (well, not Heroku because they're discontinuing free dynos in November although there will be other options - you can even host an API on a Raspberry PI!)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3sidedcube%2Fbuhackathonapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F3sidedcube%2Fbuhackathonapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3sidedcube%2Fbuhackathonapi/lists"}