Skip to content

Latest commit

 

History

History

client

README.md

UserVote Client

The client for UserVote. Built with TypeScript, React, React-Query, and Material UI.

Requirements

Node.js version 20.x, recommended to use nvm which will automatically use the .nvmrc file to set the correct version of Node.js.

Installation

See Installation in the root README.md

Updating the API Types

  1. Start the server, see server/README.md
  2. Navigate to the server docs url in your browser, i.e. http://localhost:8000/docs
  3. Click the /openapi.json link at the top of the page
  4. Save the file to client/src/api/openapi.json, replacing the existing file
  5. From the client root, run npm run api:generate to generate the TypeScript types and api methods

Planned Features

See Planned Features in the root README.md