Tutorial: Local Host - Revision history

Camyza: Edited some text to make it flow better as well as backspacing it to connect to the earlier sentence.

2024-07-29T05:21:42Z

Edited some text to make it flow better as well as backspacing it to connect to the earlier sentence.

Camyza: Added moif's tutorial.

2024-07-29T05:20:11Z

Added moif's tutorial.

Mercury: Update for new version of LK

2023-03-29T17:03:07Z

Update for new version of LK

Mercury at 16:26, 25 September 2021

2021-09-25T16:26:24Z

Mercury at 16:22, 25 September 2021

2021-09-25T16:22:08Z

Mercury at 20:33, 24 September 2021

2021-09-24T20:33:59Z

Mercury at 16:30, 15 August 2021

2021-08-15T16:30:42Z

Mercury: /* Example .env File */

2021-06-20T19:49:38Z

Example .env File

Mercury: /* Example .env File */

2021-06-20T19:47:28Z

Example .env File

Mercury: /* Example .env File */

2021-06-20T19:46:50Z

Example .env File

@@ Line 7: / Line 7: @@
 This guide takes the approach that the reader has no or very little knowledge about XAMPP before beginning the guide. It may be more beneficial for more advanced users to skip towards the end of the guide, or read Draginraptor’s guide located [https://docs.google.com/document/d/1ZABiRuj8gUZ-re1BMzHiAivJcamVPSd-sp-3EsZ5NW4/edit# here].
-This guide is also made under the assumption the user is already familiar with Sourcetree or another git client and has a local copy of the Lorekeeper files. See [[Tutorial: Introduction To Git]] for git basics.
+This guide is also made under the assumption the user is already familiar with Sourcetree or another git client and has a local copy of the Lorekeeper files. See [[Tutorial: Introduction To Git]] for git basics.  Moif has an excellent tutorial [https://resisted-april-a96.notion.site/Getting-a-Copy-of-LK-6b2e183f1bbd4582821b8c6e610c51dd?pvs=4# located here] using Sourcetree to get a local copy.  You cannot just download it from github directly, you must use something like SourceTree due to how Lorekeeper is built.
 '''Original/Google doc version:''' https://docs.google.com/document/d/1K7_BAYfTg7ZQahxNMcILLyn5D5mIGnnKvqhYOm6iFKo/edit?usp=sharing

@@ Line 7: / Line 7: @@
 This guide takes the approach that the reader has no or very little knowledge about XAMPP before beginning the guide. It may be more beneficial for more advanced users to skip towards the end of the guide, or read Draginraptor’s guide located [https://docs.google.com/document/d/1ZABiRuj8gUZ-re1BMzHiAivJcamVPSd-sp-3EsZ5NW4/edit# here].
 This guide is also made under the assumption the user is already familiar with Sourcetree or another git client and has a local copy of the Lorekeeper files. See [[Tutorial: Introduction To Git]] for git basics.
 '''Original/Google doc version:''' https://docs.google.com/document/d/1K7_BAYfTg7ZQahxNMcILLyn5D5mIGnnKvqhYOm6iFKo/edit?usp=sharing

@@ Line 17: / Line 17: @@
 *[https://www.apachefriends.org/index.html XAMPP]
-**Note that you must download a version of XAMPP with specifically <u>PHP 7.4</u>.
+**Note that you must download a version of XAMPP with specifically <u>PHP 8.1</u>.
 If you see the following warning, press OK. Provided you have followed the instructions in it and installed XAMPP in a different location, it shouldn’t impact anything Lorekeeper related.

@@ Line 7: / Line 7: @@
 This guide takes the approach that the reader has no or very little knowledge about XAMPP before beginning the guide. It may be more beneficial for more advanced users to skip towards the end of the guide, or read Draginraptor’s guide located [https://docs.google.com/document/d/1ZABiRuj8gUZ-re1BMzHiAivJcamVPSd-sp-3EsZ5NW4/edit# here].
-This guide is also made under the assumption the user is already familiar with Sourcetree and has a local copy of the Lorekeeper files.
+This guide is also made under the assumption the user is already familiar with Sourcetree or another git client and has a local copy of the Lorekeeper files. See [[Tutorial: Introduction To Git]] for git basics.
 '''Original/Google doc version:''' https://docs.google.com/document/d/1K7_BAYfTg7ZQahxNMcILLyn5D5mIGnnKvqhYOm6iFKo/edit?usp=sharing

@@ Line 17: / Line 17: @@
 *[https://www.apachefriends.org/index.html XAMPP]
-**Note that you must download a version of XAMPP with <u>PHP 7.4</u>.
+**Note that you must download a version of XAMPP with specifically <u>PHP 7.4</u>.
 If you see the following warning, press OK. Provided you have followed the instructions in it and installed XAMPP in a different location, it shouldn’t impact anything Lorekeeper related.
@@ Line 77: / Line 77: @@
 Create a new database:
 [[File:Image16.png|none|thumb]]
-[[File:Image4.png|none|thumb]]
+[[File:Image4.png|none|thumb]]Set the name aside to add to your .env file.
-An example .env is included at the bottom of this tutorial.
+Create a file in your Lorekeeper directory with the name <code>.env</code>. An example .env is included at the bottom of this tutorial.
 Once done and packages have been installed using Composer, run the following commands in command prompt, ensuring you are in your Lorekeeper directory:

@@ Line 1: / Line 1: @@
 '''NOTE THAT THIS IS FOR A WINDOWS BASED SETUP'''
-I personally use a windows device, I have very limited knowledge of MacOS or Linux setup, however both should be very similar. I cannot provide help for bugs encountered on these Operating Systems outside of general google search.
+I personally use a windows device, I have very limited knowledge of MacOS or Linux* setup, however both should be very similar. I cannot provide help for bugs encountered on these Operating Systems outside of general google search.
 '''Lorekeeper Setup Tutorial: [[Tutorial: Setting Up]]'''
@@ Line 11: / Line 11: @@
 '''Original/Google doc version:''' https://docs.google.com/document/d/1K7_BAYfTg7ZQahxNMcILLyn5D5mIGnnKvqhYOm6iFKo/edit?usp=sharing
-== Install/Initial Setup ==
+<nowiki>*</nowiki>Note from Mercury: I ''do'' have experience with setting up a local dev environment on Linux and will assemble a basic guide on request if there is interest.
 '''To begin our tutorial, you’ll need the following:'''
@@ Line 27: / Line 29: @@
 (OPTIONAL) To make starting your server easier, consider enabling MySQL and Apache to either:
-* Start as a service (requires running XAMPP in administrator mode), or
+*Start as a service (requires running XAMPP in administrator mode), or
-* Start as soon as XAMPP is opened.
+*Start as soon as XAMPP is opened.
-** You can do this by going into config:<br />
+**You can do this by going into config:<br />
 [[File:Image5.png|none|thumb]]
@@ Line 37: / Line 39: @@
 Click save and it should be done!
-== Lorekeeper Setup ==
+==Lorekeeper Setup==
 Similarly to live servers, Lorekeeper running locally requires a database and packages (managed by Composer).
@@ Line 102: / Line 104: @@
 You now have two options for accessing your local Lorekeeper:
-* Editing your Document Root
+*Editing your Document Root
-** This is recommended if you are only working on one project (in this case, Lorekeeper), as you can set it up initially and then have it just work.
+**This is recommended if you are only working on one project (in this case, Lorekeeper), as you can set it up initially and then have it just work.
-* Using <code>php artisan serve</code>
+*Using <code>php artisan serve</code>
-** This is recommended if you work on multiple projects, as it makes it much easier to switch between them on the fly without having to make config edits...
+**This is recommended if you work on multiple projects, as it makes it much easier to switch between them on the fly without having to make config edits...
-** And/or if you have other things you host locally via XAMPP, as editing your document root will disrupt access to them.
+**And/or if you have other things you host locally via XAMPP, as editing your document root will disrupt access to them.
-** However, you must run the command each time you wish to access your local Lorekeeper.
+**However, you must run the command each time you wish to access your local Lorekeeper.
-=== Editing your Document Root ===
+===Editing your Document Root===
 Once this process has completed, open XAMPP and STOP your Apache service.
 [[File:Image21.png|none|thumb]]
@@ Line 131: / Line 133: @@
 [[File:Image18.png|none|thumb|530x530px]]
-=== Using Serve ===
+===Using Serve===
 If you work on multiple projects or have difficulty with the above method, you can run a Laravel development server by using the <code>php artisan serve</code> command in your Lorekeeper directory like any other <code>php artisan</code> command. By default this command starts a development server on http://127.0.0.1:8000, but this can be configured using the following options:
-* <code>--port=PORT HERE</code>
+*<code>--port=PORT HERE</code>
-* <code>--host=IP HERE</code>
+*<code>--host=IP HERE</code>
-=== Accessing your local Lorekeeper on other devices ===
+===Accessing your local Lorekeeper on other devices===
 If both devices (your host computer and any other device capable of browsing the internet) are on the same network (WiFi or otherwise), you can access a locally hosted site on another device! This can be useful for testing on mobile devices if you want to go beyond simulating them via dev tools in-browser, for instance.
 You will need the IP address of the computer "hosting" your local site within your local network and/or its name, as well as another web-capable device.
-==== Finding your computer's IP address and name ====
+====Finding your computer's IP address and name====
 How to find your computer's IP:
-# Press Win+R to bring up 'run'; type in cmd and press enter. This should bring up the command prompt.
+#Press Win+R to bring up 'run'; type in cmd and press enter. This should bring up the command prompt.
-# Type ipconfig. Look for IPv4 Address. This is your computer's IP address within the network, and can be used to access it from other devices within the network.
+#Type ipconfig. Look for IPv4 Address. This is your computer's IP address within the network, and can be used to access it from other devices within the network.
 How to find your computer's name:
-# Open File Explorer; on Win10, right click 'This PC' in the sidebar and select Properties in the dropdown menu.
+#Open File Explorer; on Win10, right click 'This PC' in the sidebar and select Properties in the dropdown menu.
-# Find Device Name in the info displayed. This is the computer's name. You can use this to access the computer from [DEVICENAME].local on other devices within the network.
+#Find Device Name in the info displayed. This is the computer's name. You can use this to access the computer from [DEVICENAME].local on other devices within the network.
-==== Accessing your site ====
+====Accessing your site====
 If you're serving your local site via XAMPP(/edited your document root) already:
-# Try accessing XAMPP on another device. If you have not changed the port XAMPP is listening on, you will be able to access it just via typing the host computer's local IP or <code>DEVICENAME.local</code> into the address bar of your browser on the other device. If you have changed it, add the port after either method, for example <code>:8080</code> if you have XAMPP listening on 8080.
+#Try accessing XAMPP on another device. If you have not changed the port XAMPP is listening on, you will be able to access it just via typing the host computer's local IP or <code>DEVICENAME.local</code> into the address bar of your browser on the other device. If you have changed it, add the port after either method, for example <code>:8080</code> if you have XAMPP listening on 8080.
-# If you have XAMPP configured to serve Lorekeeper, you should be set at this point, and should be able to interact with the site and test as needed.
+#If you have XAMPP configured to serve Lorekeeper, you should be set at this point, and should be able to interact with the site and test as needed.
 If that doesn't work/you're using <code>php artisan serve</code>:
-# On the host computer, serve your site using <code>php artisan serve --port=PORT --host=LOCAL IP</code>.
+#On the host computer, serve your site using <code>php artisan serve --port=PORT --host=LOCAL IP</code>.
-#* The port can be any that aren't taken (8080 and higher are generally safe); telling it to listen specifically on your local IP is, at least in my experience, good for actually getting it to listen on it/to inbound requests from other devices on your local network.
+#*The port can be any that aren't taken (8080 and higher are generally safe); telling it to listen specifically on your local IP is, at least in my experience, good for actually getting it to listen on it/to inbound requests from other devices on your local network.
-#* Windows may prompt you re firewall permissions for PHP; allow it at your discretion (it does need some kind of permissions for this to work, though. I just have it set up for private networks since my home network fits that description.)
+#*Windows may prompt you re firewall permissions for PHP; allow it at your discretion (it does need some kind of permissions for this to work, though. I just have it set up for private networks since my home network fits that description.)
 You should now be able to access your site on other devices via <code>LOCALIP:PORT</code> or <code>DEVICENAME.local:PORT</code>!
-== Example .env File ==
+==Example .env File==
 Copy paste this if you are unsure what should be in your .env file.
@@ Line 221: / Line 223: @@
 </pre>
-== Common Errors ==
+==Common Errors==
-* Composer has ran out of memory
+*Composer has ran out of memory
-** Ensure that you have updated to the latest version of Composer, and to Composer v2 at minimum, as it is much less memory-intensive.
+**Ensure that you have updated to the latest version of Composer, and to Composer v2 at minimum, as it is much less memory-intensive.
-*** You can do this by running <code>composer self-update</code>.
+***You can do this by running <code>composer self-update</code>.
-** If updating Composer fails, you will need to find your php.ini file and set the memory limit to -1
+**If updating Composer fails, you will need to find your php.ini file and set the memory limit to -1
-* Apache shutdown unexpectedly
+*Apache shutdown unexpectedly
-** This error is usually caused by a mistyped / wrong document root.
+**This error is usually caused by a mistyped / wrong document root.
 [[Category:Community Tutorials]]

@@ Line 219: / Line 219: @@
 MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
 MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"
 </pre>

@@ Line 173: / Line 173: @@
 <pre>
- APP_NAME=Lorekeeper
+APP_NAME=Lorekeeper
- APP_ENV=local
+APP_ENV=local
- APP_KEY=
+APP_KEY=
- APP_DEBUG=true
+APP_DEBUG=true
- APP_URL=<nowiki>http://localhost</nowiki>
+APP_URL=<nowiki>http://localhost</nowiki>
- CONTACT_ADDRESS=
+LOG_CHANNEL=stack
- DEVIANTART_ACCOUNT=
+DB_CONNECTION=mysql
 DB_HOST=127.0.0.1
- LOG_CHANNEL=stack
+DB_PORT=3306
- DB_CONNECTION=mysql
+DB_DATABASE=change to your database name! no spaces
- DB_HOST=127.0.0.1
+DB_USERNAME=root
- DB_PORT=3306
+DB_PASSWORD=
- DB_DATABASE=change to your database name! no spaces
- DB_USERNAME=root
+BROADCAST_DRIVER=log
- DB_PASSWORD=
+CACHE_DRIVER=file
 QUEUE_CONNECTION=sync
- BROADCAST_DRIVER=log
+SESSION_DRIVER=file
- CACHE_DRIVER=file
+SESSION_LIFETIME=120
- QUEUE_CONNECTION=sync
- SESSION_DRIVER=file
+REDIS_HOST=127.0.0.1
- SESSION_LIFETIME=120
+REDIS_PASSWORD=null
 REDIS_PORT=6379
- REDIS_HOST=127.0.0.1
- REDIS_PASSWORD=null
+MAIL_DRIVER=
- REDIS_PORT=6379
+MAIL_HOST=
 MAIL_PORT=587
- MAIL_DRIVER=
+MAIL_USERNAME=
- MAIL_HOST=
+MAIL_PASSWORD=
- MAIL_PORT=587
+MAIL_FROM_ADDRESS=
- MAIL_USERNAME=
+MAIL_FROM_NAME=
- MAIL_PASSWORD=
- MAIL_FROM_ADDRESS=
+AWS_ACCESS_KEY_ID=
- MAIL_FROM_NAME=
+AWS_SECRET_ACCESS_KEY=
 AWS_DEFAULT_REGION=
- AWS_ACCESS_KEY_ID=
+AWS_BUCKET=
- AWS_SECRET_ACCESS_KEY=
- AWS_DEFAULT_REGION=
+PUSHER_APP_ID=
- AWS_BUCKET=
+PUSHER_APP_KEY=
 PUSHER_APP_SECRET=
- PUSHER_APP_ID=
+PUSHER_APP_CLUSTER=
- PUSHER_APP_KEY=
+MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
- PUSHER_APP_SECRET=
+MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"
- PUSHER_APP_CLUSTER=
- MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
+DEVIANTART_CLIENT_ID=
- MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"
+DEVIANTART_CLIENT_SECRET=
 DEVIANTART_CALLBACK_URL=/
 </pre>