Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 1010 Bytes

README.md

File metadata and controls

32 lines (21 loc) · 1010 Bytes

Mock Radar API

This project is a mock API for the Search API of Radar. It uses json-server and faker.js to generate fake data.

Table of Contents

Installation

  1. Clone the repository: git clone https://github.com/Christian-Garrison/mock-radar-api.git
  2. Navigate to the project directory: cd project-directory
  3. Install the dependencies: yarn install
  4. Add Radar API key to .env file (see example)

Usage

  1. Generate the fake data: yarn generate
  2. Start the JSON server: yarn start
  3. The server will be running on http://localhost:3001

Contributing

Contributions are welcome! Please follow the guidelines in CONTRIBUTING.md.

License

This project is licensed under the MIT License.