This project is a simple proxy server that fetches data from the San Francisco Mobile Food Facility Permit API and returns it in a more user-friendly format. The API is available at https://data.sfgov.org/resource/rqzj-sfat.json.
The API at https://data.sfgov.org/resource/rqzj-sfat.json uses a single string query parameter to filter the data. This is not user-friendly, as it requires the user to know the exact query string to use. This project provides a more user-friendly interface by allowing the user to filter the data using query parameters in the URL.
To install the project, clone the repository and run npm install
to install the dependencies.
Initialize a base .env file
NODE_ENV=development
PORT=3000
To run the project locally, run npm run dev
. The server will start on port 3000 by default.
- Node.js
- Express.js
- Axios
- Nodemon (for development)
- GET
/food-trucks
- Returns a list of food trucks based on the query parameters provided- Current Query Parameters
limit
- The number of results to return. Default is 10.offset
- The number of results to skip. Default is 0.where
- The query string to filter the results. Default is an empty string.order by
- The order in which to return the results. Default isapplicant ASC
.
- Current Query Parameters
- GET
/system/health
- Returns the health status of the server.