Add guide to README

This commit is contained in:
itsuyomi 2023-01-15 04:58:42 -05:00
parent c87a897f7f
commit 492954aba8
1 changed files with 25 additions and 1 deletions

View File

@ -1,3 +1,27 @@
# pygmalion-web-frontend
Frontend website for Pygmalion AI.
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`