You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
RESTful API for disc golf discs.
4
4
5
-
Enables developers to programmatically access public disc information from the amazing [Marshall Street Disc Golf Interactive Flight Guide](https://www.marshallstreetdiscgolf.com/flightguide) web page. Disc data is refreshed nightly via the [DiscIt API Refresh Service](https://github.com/cdleveille/discit-api-refresh).
5
+
Enables developers to programmatically access public disc information from the amazing [Marshall Street Disc Golf Interactive Flight Guide](https://www.marshallstreetdiscgolf.com/flightguide) web page. Disc data is refreshed nightly via the [DiscIt API Refresh Service](https://github.com/DiscIt-API/discit-api-refresh).
6
6
7
7
Check it out live on fly.io! [discit-api.fly.dev/disc](https://discit-api.fly.dev/disc)
8
8
@@ -46,14 +46,14 @@ Refer to the **Fields** section below for all possible query string parameters,
46
46
## Setup
47
47
48
48
- Install [bun](https://bun.sh).
49
-
- Install package dependencies: `bun i`
49
+
- Install package dependencies: `bun install`
50
50
- Create and populate a `.env` file based on the `.env.example` file in the root directory.
51
-
-`API_KEY`: Secret key used to authenticate requests to the API. Can be any string value, but must match the value used in the [discit-api-refresh](https://github.com/cdleveille/discit-api-refresh) project.
51
+
-`API_KEY`: Secret key used to authenticate requests to the API. Can be any string value, but must match the value used in the [discit-api-refresh](https://github.com/DiscIt-API/discit-api-refresh) project.
52
52
-`MONGO_URI` (optional): Connection string to a MongoDB database. If not provided, a Docker container will need to be used instead to host the database locally.
53
53
- If not using a custom MongoDB connection string, install and run [Docker Desktop](https://www.docker.com/products/docker-desktop). Run `bun compose` to initialize the database container.
54
54
- Run `bun dev` to start in watch mode (server restarts on file save).
55
55
- Server will listen for requests on [localhost:5000](http://localhost:5000).
56
-
- To populate the database with disc data, refer to the setup instructions for the [discit-api-refresh](https://github.com/cdleveille/discit-api-refresh) process.
56
+
- To populate the database with disc data, refer to the setup instructions for the [discit-api-refresh](https://github.com/DiscIt-API/discit-api-refresh) process.
57
57
58
58
## Technologies
59
59
@@ -64,7 +64,7 @@ Refer to the **Fields** section below for all possible query string parameters,
64
64
65
65
## See Also
66
66
67
-
-[DiscIt](https://github.com/cdleveille/discit) - a responsive disc golf disc search engine that uses the DiscIt API.
67
+
-[DiscIt](https://github.com/DiscIt-API/discit) - a responsive disc golf disc search engine that uses the DiscIt API.
68
68
-[Marshall Street Disc Golf Interactive Flight Guide](https://www.marshallstreetdiscgolf.com/flightguide)
69
69
-[PDGA REST API Services](https://www.pdga.com/dev/api/rest/v1/services)
0 commit comments