https://github.com/michellbrito/golfmini
A directory of mini golf courses where users can search, book, and review mini golf experiences
https://github.com/michellbrito/golfmini
Last synced: 12 months ago
JSON representation
A directory of mini golf courses where users can search, book, and review mini golf experiences
- Host: GitHub
- URL: https://github.com/michellbrito/golfmini
- Owner: michellbrito
- Created: 2024-12-21T04:13:09.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-18T16:29:45.000Z (about 1 year ago)
- Last Synced: 2025-06-21T09:06:43.883Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://golfmini.com
- Size: 5.17 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GolfMini
A directory of mini-golf courses where users can search
## Features
- [ ] Search by location
- [ ] View photos
## Tech Stack
**Client:** React, Next.js, Chakra UI
**Server:** Node, Express, Prisma
**DB:** MYSQL
## Run Locally
Clone the project
```bash
git clone git@github.com:michellbrito/golfmini.git
```
Go to the project directory
```bash
cd golfmini
```
Install dependencies
```bash
npm run client:install
npm run server:install
```
Start the server
```bash
npm run server:start
```
Start the client
```bash
npm run client:dev
```
## API Reference
#### Gets all mini golf locations - `/locations`
| Query | Type | Description |
| :-------- | :------- | :------------------------- |
| `type` | `string` | The type of the location such as indoor, and outdoor |
| `theme` | `string` | The theme of the location such as castle, glow in the dark, pirate, and jungle |
| `state` | `string` | State within USA |
| `city` | `string` | City within USA |
| `page` | `int` | The paginated page results should be fetched from |
| `limit` | `int` | The maximum number of locations should be returned |
#### Gets a specific location - `/locations/:id`
| Params | Type | Description |
| :-------- | :------- | :------------------------- |
| `id` | `int` |The id of a specific location |
## Environment Variables
To run this project, you will need to create 2 .env files 1 within client and 1 within server
### Client Environment Variables
`NEXT_PUBLIC_API_URL`
### Server Environment Variables
`DATABASE_URL`
`CLIENT_URL`