Skip to content
This repository has been archived by the owner on Sep 15, 2021. It is now read-only.

Latest commit

 

History

History
41 lines (25 loc) · 1.08 KB

README.md

File metadata and controls

41 lines (25 loc) · 1.08 KB

TeachUsPlease

A web-based user interface for TeachUsPlease, built with Vue 3, written in TypeScript.

Table of Contents

Getting Started

Installation

Execute yarn to install all the dependencies. If you haven't installed yarn before, use the command npm install -g yarn.

Development

Execute yarn serve to start a development server. Modifying your code will automatically trigger rebuild and hot reload in your page.

Building

Execute yarn build to build the server in production mode.

Usage

The Node.js server for production usage is not yet implemented.

API Design

See ./src/components/types for details.

Examples

See ./src/api for details, or especially, ./src/api/mock for mock data examples.