Skip to content

Commit 46f2a33

Browse files
committed
cleanup
1 parent 1744834 commit 46f2a33

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
RESTful API for disc golf discs.
44

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).
66

77
Check it out live on fly.io! [discit-api.fly.dev/disc](https://discit-api.fly.dev/disc)
88

@@ -46,14 +46,14 @@ Refer to the **Fields** section below for all possible query string parameters,
4646
## Setup
4747

4848
- Install [bun](https://bun.sh).
49-
- Install package dependencies: `bun i`
49+
- Install package dependencies: `bun install`
5050
- 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.
5252
- `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.
5353
- 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.
5454
- Run `bun dev` to start in watch mode (server restarts on file save).
5555
- 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.
5757

5858
## Technologies
5959

@@ -64,7 +64,7 @@ Refer to the **Fields** section below for all possible query string parameters,
6464

6565
## See Also
6666

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.
6868
- [Marshall Street Disc Golf Interactive Flight Guide](https://www.marshallstreetdiscgolf.com/flightguide)
6969
- [PDGA REST API Services](https://www.pdga.com/dev/api/rest/v1/services)
7070
- [Disc Flight Ratings System](https://www.innovadiscs.com/home/disc-golf-faq/flight-ratings-system)

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@
88
"module": "src/index.ts",
99
"repository": {
1010
"type": "git",
11-
"url": "git+https://github.com/cdleveille/discit-api.git"
11+
"url": "git+https://github.com/DiscIt-API/discit-api.git"
1212
},
1313
"bugs": {
14-
"url": "https://github.com/cdleveille/discit-api/issues"
14+
"url": "https://github.com/DiscIt-API/discit-api/issues"
1515
},
16-
"homepage": "https://github.com/cdleveille/discit-api#readme",
16+
"homepage": "https://github.com/DiscIt-API/discit-api#readme",
1717
"scripts": {
1818
"compose": "docker compose -f \"./.discit-dev-container/docker-compose.yml\" up -d --build",
1919
"prepare": "lefthook install",

0 commit comments

Comments
 (0)