Sancaros/phantasmal-world
1
0
Fork 0
mirror of https://github.com/DaanVandenBosch/phantasmal-world.git synced 2025-04-04 22:58:29 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Removed all reference to React and Mobx from the readme and added a note about linting/formatting.

Browse Source
This commit is contained in:
Daan Vanden Bosch 2019-09-14 18:04:28 +02:00
parent 6f6bac6f3e
commit 22bf650f04
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -4,7 +4,7 @@ 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.
See [features](./FEATURES.md) for a list of features, planned features and bugs.
### Getting Started
@ -12,11 +12,17 @@ React is used for the frontend, MobX is used for state management and THREE.js f
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
5. src/index.ts is the application's entry point
### Tests
Run tests with `yarn test`. The testing framework used is Jest.
Run tests with `yarn test` (or `yarn test --watch`). The testing framework used is Jest.
### Linting and Code Formatting
ESLint and Prettier are used for linting and formatting.
Run with `yarn lint` and/or configure your editor to use the ESLint/Prettier configuration.
### Production Build