phantasmal-world/README.md

# Phantasmal World

Phantasmal World is a suite of tools for Phantasy Star Online.

## For Developers

React is used for the frontend, MobX is used for state management and THREE.js for 3D graphics. See [features](./FEATURES.md) for a list of features, planned features and bugs.

### Getting Started

1. Install Yarn ([https://yarnpkg.com/](https://yarnpkg.com/))
2. cd to the project directory
3. Install dependencies with `yarn`
4. Launch server on [http://localhost:1623/](http://localhost:1623/) with `yarn start`
5. src/index.tsx is the application's entry point

### Tests

Run tests with `yarn test`. The testing framework used is Jest.

### Production Build

Create an optimized production build with `yarn build`.