{"id":23448399,"url":"https://github.com/michellbrito/golfmini","last_synced_at":"2025-07-05T16:36:23.418Z","repository":{"id":269219849,"uuid":"906494939","full_name":"michellbrito/golfmini","owner":"michellbrito","description":"A directory of mini golf courses where users can search, book, and review mini golf experiences","archived":false,"fork":false,"pushed_at":"2025-05-18T16:29:45.000Z","size":5426,"stargazers_count":0,"open_issues_count":11,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-21T09:06:43.883Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://golfmini.com","language":"JavaScript","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/michellbrito.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,"zenodo":null}},"created_at":"2024-12-21T04:13:09.000Z","updated_at":"2025-05-16T02:53:20.000Z","dependencies_parsed_at":"2025-01-23T07:24:56.501Z","dependency_job_id":"a17c70ec-19cc-4fc9-9485-40a40ee0b3a4","html_url":"https://github.com/michellbrito/golfmini","commit_stats":null,"previous_names":["michellbrito/golfmini"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/michellbrito/golfmini","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michellbrito%2Fgolfmini","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michellbrito%2Fgolfmini/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michellbrito%2Fgolfmini/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michellbrito%2Fgolfmini/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/michellbrito","download_url":"https://codeload.github.com/michellbrito/golfmini/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michellbrito%2Fgolfmini/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261095310,"owners_count":23108784,"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-23T22:15:47.771Z","updated_at":"2025-06-21T09:06:55.061Z","avatar_url":"https://github.com/michellbrito.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# GolfMini\n\nA directory of mini-golf courses where users can search \n\n\u003cimg src=\"https://github.com/user-attachments/assets/fed9142b-049a-4ea0-b693-58defbebf1eb\" height=\"800px\"/\u003e\n\n## Features\n\n- [ ] Search by location\n- [ ] View photos\n\n## Tech Stack\n\n**Client:** React, Next.js, Chakra UI\n\n**Server:** Node, Express, Prisma\n\n**DB:** MYSQL\n\n## Run Locally\n\nClone the project\n\n```bash\n  git clone git@github.com:michellbrito/golfmini.git\n```\n\nGo to the project directory\n\n```bash\n  cd golfmini\n```\n\nInstall dependencies\n\n```bash\n  npm run client:install\n  npm run server:install\n```\n\nStart the server\n\n```bash\n  npm run server:start\n```\n\nStart the client\n\n```bash\n  npm run client:dev\n```\n\n## API Reference\n\n#### Gets all mini golf locations - `/locations`\n\n| Query | Type     | Description                |\n| :-------- | :------- | :------------------------- |\n| `type` | `string` | The type of the location such as indoor, and outdoor |\n| `theme` | `string` | The theme of the location such as castle, glow in the dark, pirate, and jungle |\n| `state` | `string` | State within USA |\n| `city` | `string` | City within USA |\n| `page` | `int` | The paginated page results should be fetched from |\n| `limit` | `int` | The maximum number of locations should be returned |\n\n\n#### Gets a specific location - `/locations/:id`\n\n| Params | Type     | Description                |\n| :-------- | :------- | :------------------------- |\n| `id` | `int` |The id of a specific location |\n\n## Environment Variables\n\nTo run this project, you will need to create 2 .env files 1 within client and 1 within server\n\n### Client Environment Variables \n`NEXT_PUBLIC_API_URL`\n\n### Server Environment Variables \n`DATABASE_URL`\n\n`CLIENT_URL`\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichellbrito%2Fgolfmini","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichellbrito%2Fgolfmini","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichellbrito%2Fgolfmini/lists"}