https://github.com/blakek/mississippi-burn-bans-api
🔥 List current outdoor burn bans for the state of Mississippi
https://github.com/blakek/mississippi-burn-bans-api
Last synced: over 1 year ago
JSON representation
🔥 List current outdoor burn bans for the state of Mississippi
- Host: GitHub
- URL: https://github.com/blakek/mississippi-burn-bans-api
- Owner: blakek
- Created: 2025-03-18T18:38:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-18T20:26:37.000Z (over 1 year ago)
- Last Synced: 2025-04-24T05:38:57.193Z (over 1 year ago)
- Language: TypeScript
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mississippi-burn-bans-api
> 🔥 A lightweight API to fetch and serve burn ban data for Mississippi counties.
## Overview
This API provides endpoints to retrieve burn ban data for Mississippi counties. The data is fetched from the Mississippi Forestry Commission's website and cached for efficient access.
### Endpoints
#### `GET /api/burn-bans`
- Returns a list of all burn bans.
- Example response:
```json
[
{
"counties": "Hinds",
"issued": "2025-04-01T00:00:00.000Z",
"expires": "2025-04-15T00:00:00.000Z",
"exemptions": "Agricultural burns"
}
]
```
#### `GET /api/burn-bans/:county`
- Returns burn ban data for a specific county.
- Example response:
```json
{
"counties": "Hinds",
"issued": "2025-04-01T00:00:00.000Z",
"expires": "2025-04-15T00:00:00.000Z",
"exemptions": "Agricultural burns"
}
```
## Contributing
### Prerequisites
- [Bun.sh](https://bun.sh/) >=v1.2
### Setup
1. Clone the repository:
```bash
git clone https://github.com/blakek/mississippi-burn-bans-api
cd mississippi-burn-bans-api
```
2. Install dependencies:
```bash
bun install
```
### Running the Project
To start the API server:
```bash
# for production
bun start
# or with hot reloading for development
bun dev
```
The server will start and display the URL where it is running (e.g., `http://localhost:3000`).
### Useful Commands
| Command | Description |
| --------------- | ------------------------------------ |
| `bun install` | Install project dependencies. |
| `bun start` | Start the API server. |
| `bun dev` | Start the server with hot reloading. |
| `bun test` | Run tests. |
| `bun typecheck` | Check TypeScript types. |