Skip to content

Commit

Permalink
Update README.md [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
userXinos authored Feb 3, 2024
1 parent 2f50edd commit 2333296
Showing 1 changed file with 16 additions and 20 deletions.
36 changes: 16 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,30 @@
# HadesSpace
Parsing and displaying game data
<p align="center"><img src="/src/img/logo.png" alt="logo"></p>
<h1 align="center">HadesSpace</h1>

### Build
The project contains a tool for parsing csv tables compiled from game data. The developed parser combines information from various game tables, collecting data in a convenient format (.js, .json etc). Parsed data is also used by community members to develop their Discord bots.

```bash
# install dependencies
npm install
The Vuejs3 web application supports PWA and optimal display on various screens, and also supports the entire locale from the game and additional ones contributed by the community. [Current deployment](https://userxinos.github.io/HadesSpace/)

# build
npm run build
```
If you are a data miner, you can find tables in the [parser directory](/parser), and images in [src](src/img)

### Build a developer build
### Build web-app

```bash
# install dependencies if not already installed
npm install

# parse game data
npm run parser
npm install # install dependencies
npm run build # build
```

# generate localization strings
npm run i18n:full
### Build a developer build

# deploy local server
npm run dev
```bash
npm install # install dependencies if not already installed
npm run parser # parse game data
npm run i18n:full # generate localization strings
npm run dev # deploy local server
```

### Requirements
- Latest LTS version of [NodeJS](https://nodejs.org)
- 17 version of [NodeJS](https://nodejs.org)


### Modules
Expand Down

0 comments on commit 2333296

Please sign in to comment.