Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #87

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #87

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Herald, frontend for Writtn Realms.
# Herald, the frontend for Written Realms.

Herald is the code for the game of https://writtenrealms.com, as well as its world editor. It is
written in [Vue.js](https://vuejs.org/), using [TypeScript](https://www.typescriptlang.org/) and
[SASS](https://sass-lang.com/).

## Development

To run the frontend locally against the production Written Realms backend, install the porject and then run it with [Vite](https://vitejs.dev/):
To run the frontend locally against the production Written Realms backend, install the project and then run it with [Vite](https://vitejs.dev/):

```
npm install
Expand All @@ -16,7 +16,7 @@ npm run dev
### Development against a local backend


If you are running a local copy of the Written Realms backend, update the API and Websocket endpoints if necessary in `.env.dev` then run:
If you are running a local copy of the Written Realms backend, update the API and WebSocket endpoints if necessary in `.env.dev` then run:
```
npm install
num run dev-local
Expand Down