Update readme
This commit is contained in:
23
README.md
23
README.md
@@ -18,23 +18,20 @@
|
||||
- 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
|
||||
- This will create and seed 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
|
||||
```
|
||||
❯ curl 'localhost:3000/api/v1/parks?per_page=1' | jq '.'
|
||||
[
|
||||
{
|
||||
"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"
|
||||
❯ curl 'localhost:3000/api/v1/stats'
|
||||
{
|
||||
"park_count": 474,
|
||||
"alert_count": 708,
|
||||
"most_alerts": {
|
||||
"park_code": "zion",
|
||||
"alert_count": 6
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Testing
|
||||
@@ -43,7 +40,7 @@
|
||||
bin/rspec
|
||||
```
|
||||
|
||||
## TODO
|
||||
## Notes
|
||||
|
||||
- What additional cols to add to parks model?
|
||||
- Order results on index actions
|
||||
|
||||
Reference in New Issue
Block a user