https://github.com/larttyler/mhwdb-api
Source code for the Monster Hunter World API project
https://github.com/larttyler/mhwdb-api
api mhw-db monster-hunter monster-hunter-world
Last synced: 4 months ago
JSON representation
Source code for the Monster Hunter World API project
- Host: GitHub
- URL: https://github.com/larttyler/mhwdb-api
- Owner: LartTyler
- License: agpl-3.0
- Created: 2018-02-20T21:54:22.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-02-12T15:51:24.000Z (over 2 years ago)
- Last Synced: 2025-10-25T22:41:31.531Z (8 months ago)
- Topics: api, mhw-db, monster-hunter, monster-hunter-world
- Language: PHP
- Homepage:
- Size: 4.47 MB
- Stars: 78
- Watchers: 7
- Forks: 12
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
> **Please note:** This is the source code for the _Monster Hunter World_ API. If you're interested in using the API itself, please [check out the docs](https://docs.mhw-db.com/).
# Getting Started
Check out the [contributing guide](.github/CONTRIBUTING.md) for information on contributing to the project. Feel free
to drop into the project's [Gitter](https://gitter.im/mhw-db/general) chat and leave some suggestions!
```sh
$ git clone https://github.com/LartTyler/MHWDB-API.git
```
## Using Vagrant
You can use the included Vagrant configuration to run your own development environment. If you're not familiar with
Vagrant, check out their [getting started](https://www.vagrantup.com/intro/index.html) guide.
In the project root, run:
```sh
$ vagrant up
```
Once the box is done provisioning, use `vagrant ssh` to access the box and run:
```sh
$ cd /vagrant
$ composer install
$ ./db-reset.sh latest
$ ./server-start.sh
```
The commands, in order, will perform the following tasks:
- 1 and 2: Navigate to the project root and install dependencies
- 3: Sync the boxes database with the most recent SQL file in the `snapshots/` directory
- 4: Start the webserver, which will make the API available on `127.0.0.1:8000`
## Manual Setup
Support is not provided for any development environments that are set up manually. If you open an issue, I'll try to
help out as much as possible, but I can't promise anything. If you'd like your devleopment environment to be supported,
please use the [Vagrant configuration](#using-vagrant).
The project requires the following software in order to run:
- PHP 7.1 or higher
- Composer
- Memcached
- MySQL 5.7 or higher OR MariaDB 10.2 or higher
After ensuring that the above packages are available, copy the `.env.dist` file to `.env` and modify it to match your
machine's configuration. Once you've done that, run the following commands to install the project requirements and start
the web server.
```sh
$ ./db-reset.sh latest
$ composer install
$ php bin/console server:start
```
Replace `` with the name of the database you'll be using for the project.
# Feature Tracking
I'm currently using a Trello board to track features and changes, which can be found [here](https://trello.com/b/KRXsLUCs/mhw-api).