From c221d786f9f362a970033bf5b2ba1a76d9c3cb83 Mon Sep 17 00:00:00 2001 From: Jack Goh Date: Wed, 18 Jul 2018 10:46:57 +0800 Subject: [PATCH] updated readme --- readme.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index ce0e683..11345bf 100644 --- a/readme.md +++ b/readme.md @@ -13,13 +13,25 @@ - HTML, CSS, Jquery - Authentication with JWT -## Installation +## Installation (For Windows) +- Download and install [Laragon](https://laragon.org/download/) +- `cd` to your local dev server htdocs or www folder +- `git clone git@gitlab.com:CIEFWorldwideSdnBhd/izyim-api.git` +- create a new database for your app and name it whatever you like. +- Copy `.env-example` to `.env` +- Edit `.env` and set your database connection details +- Run `composer install` +- Run `php artisan migrate` +- Run`php artisan db:seed` +- Run `php artisan serve` +- Navigate to `http://localhost:8000` it should show the UI + +## Installation (For Linux or OSX) +- Install [Git](https://git-scm.com) , [Docker CE](https://docs.docker.com/) and [Docker compose](https://docs.docker.com/compose/install/), [Node](https://nodejs.org/en/download/) - `git clone git@gitlab.com:CIEFWorldwideSdnBhd/izyim-api.git` - Copy `.env-example` to `.env` - Edit `.env` and set your database connection details - -## Usage - Run `docker-compose up` #### Test Credentials