Skip to content

Commit

Permalink
Add How to Run
Browse files Browse the repository at this point in the history
  • Loading branch information
leung018 committed Oct 14, 2024
1 parent 65c89e2 commit df9102b
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@

This project aims to develop a web application prototype that allows users to play previously saved multiple-choice questions, with the choices generated in a different order each time they play. The project also focuses on incorporating standard engineering practices such as **automated testing**, **continuous integration**, **continuous deployment**, and maintaining descriptive changes through **small pull requests** and **focused commits**.

## How to Run

### Prerequisites

- Node.js: I use v18 and if you use nvm, you can run `nvm use` to switch to that version.
- Yarn: Follow the instructions [here](https://yarnpkg.com/getting-started/install) for how to enabling Yarn if you haven't.

### Steps

1. `yarn install` to install dependencies
2. `yarn dev` to start the development server

## Feature Summaries

1. **Question Bank Stored in Browser Local Storage**
Expand Down

0 comments on commit df9102b

Please sign in to comment.