nvengal/national-parks-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Nikhil Vengal
2025-10-08 09:36:23 -07:00
parent b3d96e07b1
commit f5009780aa
1 changed files with 10 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -18,23 +18,20 @@
- You know this one; install dependencies - You know this one; install dependencies
2. Set `NPS_API_KEY` using your tool of choice 2. Set `NPS_API_KEY` using your tool of choice
3. `bin/rails db:prepare` 3. `bin/rails db:prepare`
- This will create and load your database - This will create and seed your database
- hint: `tail -f log/development.log` to see what's going on - hint: `tail -f log/development.log` to see what's going on
4. `bin/rails server` 4. `bin/rails server`
- Congrats you're ready to receive requests - Congrats you're ready to receive requests
``` ```
❯ curl 'localhost:3000/api/v1/parks?per_page=1' | jq '.' ❯ curl 'localhost:3000/api/v1/stats'
[ {
{ "park_count": 474,
"id": 1, "alert_count": 708,
"code": "abli", "most_alerts": {
"name": "Abraham Lincoln Birthplace", "park_code": "zion",
"states": "KY", "alert_count": 6
"properties": {},
"created_at": "2025-10-08T09:26:00.202Z",
"updated_at": "2025-10-08T09:26:00.202Z"
} }
] }
``` ```
## Testing ## Testing
@@ -43,7 +40,7 @@
bin/rspec bin/rspec
``` ```
## TODO ## Notes
- What additional cols to add to parks model? - What additional cols to add to parks model?
- Order results on index actions - Order results on index actions