/rithm-challenge

Frontend for my submission for the API challenge from Rithm

Primary LanguageJavaScript

Rithm API Challenge Client

The client for my submission for the API technical challenge provided by Rithm. Check out the backend here

Project Setup

  1. Clone the application and cd into the project directory

  2. Install dependencies:

npm i
  1. Copy the contents of .sample.env into a .env file
cat .sample.env > .env

  1. Populate the .env file with your mapbox API key and URL to a running backend server (without a trailing slash)

  2. Start a local dev server

npm run dev

CLI Commands

# install dependencies
npm install

# serve with hot reload at localhost:8080
npm run dev

# build for production with minification
npm run build

# test the production build locally
npm run serve

# run tests with jest and enzyme
npm run test

For detailed explanation on how things work, checkout the CLI Readme.

To-Do

  • Re-center the map with the help of Geolib whenever new API results are retrieved
  • Support API pagination
  • Validate query parameters at the client level
    • Reimplement form inputs (e.g., separate numeric inputs for latitude and longitude)
  • Performance
    • Async load Mapbox
    • Generate map markers in a symbol layer to support hundreds of markers
  • CRUD
    • New features allowing you to check-in your location to the database