From aa3178bb40a82176db007a78be60cc77d7943219 Mon Sep 17 00:00:00 2001 From: sg495 Date: Fri, 5 Jan 2018 00:48:27 +0100 Subject: [PATCH] Created Installation: Windows (markdown) --- Installation:-Windows.md | 51 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 Installation:-Windows.md diff --git a/Installation:-Windows.md b/Installation:-Windows.md new file mode 100644 index 0000000..2bd1c19 --- /dev/null +++ b/Installation:-Windows.md @@ -0,0 +1,51 @@ +**Installation instructions for the backend:** + +1. Download Much-Assembly-Required from [here](https://github.com/simon987/Much-Assembly-Required). +2. Download the JDK from [here](http://www.oracle.com/technetwork/java/javase/downloads/index.html). +Install the JDK and update your PATH and JAVA_HOME enviroment variables. +3. Download Maven from [here](https://maven.apache.org/). +Install Maven (following the README) and update your PATH enviroment variable. +4. Download Mongo DB Community from [here](https://www.mongodb.com/download-center#community). +Install Mongo DB following the instructions [here](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-windows/). +Update your PATH enviroment variable. + +**Installation instructions for the frontend:** + +1. Install a PHP environnment and a MySQL server (e.g. XAMPP from [here](https://www.apachefriends.org/index.html)). +2. Download Much-Assembly-Required-Frontend from [here](https://github.com/simon987/Much-Assembly-Required-Frontend), and place it into the ```htdocs``` folder for XAMPP. In a typical installation, for example, you could place the frontend files into the ```C:\xampp\htdocs\MAR``` folder. See [here](https://stackoverflow.com/questions/1408/make-xampp-apache-serve-file-outside-of-htdocs) for how to run PHP code with XAMPP outside of the ```htdocs``` folder. +3. Configure the MAR database, using the installation script [database.sql](https://github.com/simon987/Much-Assembly-Required-Frontend/blob/master/database.sql). Fire up MySQL in a Command Prompt window: +```batch +mysql -u root -p +``` +After entering your root password (XAMPP default is empty, change it!), type the following commands in the MySQL interface: +``` +MariaDB [(none)]> CREATE DATABASE mar; +MariaDB [(none)]> GRANT ALL PRIVILEGES ON mar.* to 'mar'@'localhost' identified by 'mar'; +MariaDB [(none)]> FLUSH PRIVILEGES; +MariaDB [(none)]> USE mar; +MariaDB [mar]> \. database.sql +MariaDB [(none)]> exit +``` +Remember that the database.sql file must be in the same folder you run the mysql command from. + +**Building instructions for the backend:** +```batch +:: Builds the server +cd Much-Assembly-Required +mvn package +``` + +**Running instructions:** +1. In one Command Prompt window, run Mongo DB: +```batch +:: Runs Mongo DB +mongod +``` +2. In a second Command Prompt window, run the MAR server: +```batch +:: Runs the MAR server +cd Much-Assembly-Required\target +java -jar server-1.2a.jar +``` +3. Start Apache and MySQL from the XAMPP control panel. +4. Run the frontend from localhost (e.g. if you placed the frontend into the ```C:\xampp\htdocs\MAR``` folder, you could run it from localhost by typing ```http://localhost/MAR``` in your web browser).