https://github.com/maael/ffxivpocketcraft
🔨 A tool to search xivdb and retrieve recipes based on a list of items and crafter classes for FFXIV.
https://github.com/maael/ffxivpocketcraft
ffxiv
Last synced: 3 months ago
JSON representation
🔨 A tool to search xivdb and retrieve recipes based on a list of items and crafter classes for FFXIV.
- Host: GitHub
- URL: https://github.com/maael/ffxivpocketcraft
- Owner: maael
- Created: 2018-05-31T17:36:05.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-26T06:30:23.000Z (over 2 years ago)
- Last Synced: 2025-02-13T03:49:04.422Z (5 months ago)
- Topics: ffxiv
- Language: JavaScript
- Homepage: http://pocketcraft.trade
- Size: 965 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FFXIV Pocketcraft
## Install
```
yarn
```
## Setup
### Prerequisites
- MongoDB
- Node.js (v9.x.x+, at least that's what I used)
### Config
Copy `.env.schema` to `.env`, and fill it out.
### Data
Data is pulled from [xivdb.com](http://xivdb.com), and you will want to run `yarn import-recipes` followed by `extract-items`.
These commands will populate MongoDB databases, as specified via the `MONGO_URI` and `MONGO_DB` values in `.env`. There will be a database per region, with `'_en', '_de', '_fr', '_ja'` as the suffixes on `MONGO_DB`. In the databse there will be two collections, `recipes` and `items` respectively.
### Development
```
yarn dev
```
### Production
```
yarn build && yarn start
```
Although on production this is managed via [pm2](https://github.com/Unitech/pm2).
## Available commands
- `dev` - `NODE_ENV=development node server`,
- `start` - `NODE_ENV=production node server`,
- `build` - `NODE_ENV=production next build`,
- `extract-items` - `node scripts/extract-items-from-local-recipes`,
- `import-recipes` - `node scripts/import-recipes-from-xivdb`,
- `db-dump` - `mongodump --db pocketcraft`,
- `db-restore` - `mongorestore --drop -d pocketcraft`
- `lint` - `standard`