From 492954aba8144e6b659ee0c913359fbb242cde9c Mon Sep 17 00:00:00 2001
From: itsuyomi <itsuyomi@noreply.fuwafuwa.moe>
Date: Sun, 15 Jan 2023 04:58:42 -0500
Subject: [PATCH] Add guide to README

---
 README.md | 26 +++++++++++++++++++++++++-
 1 file changed, 25 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index b57468f..1d1dac1 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,27 @@
 # pygmalion-web-frontend
 
-Frontend website for Pygmalion AI.
\ No newline at end of file
+Frontend website for Pygmalion AI.
+
+## Prerequisites
+
+- NodeJS and npm
+- [json-server](https://www.npmjs.com/package/json-server) is used to fetch placeholder data from `db-fake/db.json`.
+
+## Install
+Clone the repo and then install.
+```bash
+npm install
+```
+
+## Usage
+Run the frontend.
+```bash
+npm run dev
+```
+Then go to `http://localhost:5173/`
+
+Run the JSON server in another shell window.
+```bash
+json-server --watch db-fake/db.json
+```
+By default, the data is fetched from `http://localhost:3000`
\ No newline at end of file