Update readme
This commit is contained in:
27
README.md
27
README.md
@@ -4,9 +4,9 @@
|
|||||||
|
|
||||||
- Ruby 3.4.7
|
- Ruby 3.4.7
|
||||||
- Bundler
|
- Bundler
|
||||||
- Set `NPS_API_KEY` env var
|
- An API key from the [national parks service](https://www.nps.gov/subjects/developer/get-started.htm)
|
||||||
|
|
||||||
### Deps
|
### Under the hood
|
||||||
|
|
||||||
- Ruby 3.4.7
|
- Ruby 3.4.7
|
||||||
- Rails 8.0.3
|
- Rails 8.0.3
|
||||||
@@ -14,10 +14,27 @@
|
|||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|
||||||
|
1. `bundle install`
|
||||||
|
- You know this one; install dependencies
|
||||||
|
2. Set `NPS_API_KEY` using your tool of choice
|
||||||
|
3. `bin/rails db:prepare`
|
||||||
|
- This will create and load your database
|
||||||
|
- hint: `tail -f log/development.log` to see what's going on
|
||||||
|
4. `bin/rails server`
|
||||||
|
- Congrats you're ready to receive requests
|
||||||
```
|
```
|
||||||
bundle install
|
❯ curl 'localhost:3000/api/v1/parks?per_page=1' | jq '.'
|
||||||
bin/rails db:prepare
|
[
|
||||||
bin/rails server
|
{
|
||||||
|
"id": 1,
|
||||||
|
"code": "abli",
|
||||||
|
"name": "Abraham Lincoln Birthplace",
|
||||||
|
"states": "KY",
|
||||||
|
"properties": {},
|
||||||
|
"created_at": "2025-10-08T09:26:00.202Z",
|
||||||
|
"updated_at": "2025-10-08T09:26:00.202Z"
|
||||||
|
}
|
||||||
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
|
|||||||
Reference in New Issue
Block a user