Merge pull request #27 from sg495/master

Installation instructions restructured and more detailed
This commit is contained in:
Simon Fortier 2018-01-03 18:44:15 -05:00 committed by GitHub
commit 9d508eccf2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,9 +1,10 @@
# Much-Assembly-Required-Frontend
Files for https://muchassemblyrequired.com/ frontend.
Frontend files for the https://muchassemblyrequired.com/ game.
Information about the backend can be found [here](https://github.com/simon987/Much-Assembly-Required).
Requires a PHP environnment and a MySQL server (Database installation script: [database.sql](https://github.com/simon987/Much-Assembly-Required-Frontend/blob/master/database.sql)).
Easiest way to configure the database:
Installation instructions:
1. Install a PHP environnment and a MySQL server (e.g. XAMPP on Windows).
2. Configure the MAR database, using the installation script [database.sql](https://github.com/simon987/Much-Assembly-Required-Frontend/blob/master/database.sql):
```bash
$ pwd
~/Much-Assembly-Required-Frontend/
@ -21,9 +22,15 @@ Bye
$ # if '\. database.sql' failed you were not in the right directory. make sure you are in the repo root directory
$ # before running these commands
```
Make sure to change the configuration in /include/config.php.
> Tough if you used the snippet above there is nothing to change (except the title if you want)
More information about the game [here.](https://github.com/simon987/Much-Assembly-Required)
Running instructions:
1. Start Apache and MySQL.
2. Start the backend (see [here](https://github.com/simon987/Much-Assembly-Required) for further details).
3. Run the frontend from localhost.
When using XAMPP, for example, you can place the frontend files in the ```xampp/htdocs/MAR``` folder,
and you can run the frontend by typing ```http://localhost/MAR``` in your web browser.
If you didn't use the MySQL snippet above to configure your database, you may need to change the configuration in /include/config.php.
HTML template by ajlkn
Pixel art for the 'Factory' sprite by harveydentmd