Skip to content

update readme text with requirements & update instructions #526

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
G-Rowell wants to merge 1 commit into
base: arkham
Choose a base branch
from
Open

update readme text with requirements & update instructions #526

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,27 @@ ArkhamDB

This guide assumes you know how to use the command-line and that your machine has php and mysql installed.

## Pre-requisites

- PHP (version: ~7)
- Composer (version: 1)
- Various extra PHP modules, such as:
- php-curl
- pdo-mysql
- mysqli
- mysqlnd
- zlib
- MySQL (or MariaDB)


## Install

- install composer: https://getcomposer.org/download/
- clone the repo somewhere
- cd to it
- NOTE: use version 1.10.26 (the last release of version 1), using `php composer-setup.php --version=1.10.26`
Copy link
Copy Markdown

@cfergeau cfergeau Nov 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for the PR/issue/..., as I've been struggling with the same issues! ;)
Instead of --version=1.10.26, you can use --1 though I doubt they'll ever make a new Composer 1 release.

- Git clone the repo & `cd` to it
- run `composer install` (at the end it will ask for the database configuration parameters)
- run `php bin/console doctrine:database:create`
- run `php bin/console doctrine:schema:create`
- checkout the card data from https://github.com/Kamalisk/arkhamdb-json-data
- run `php bin/console app:import:std path-to-arkhamdb-json-data/` pointing to where you checked out the json data
- Git clone the card data from https://github.com/Kamalisk/arkhamdb-json-data
- run `php bin/console app:import:std path-to-arkhamdb-json-data/` pointing to where you cloned the json data (can be a relative path)
- run `php bin/console server:run`