Test our documentation for installation of Development with XAMPP

[Angamanga]

Intro 📖

We are continuously working with our documentation to provide a good and smooth experience when setting up the platform. In this ticket, we are asking for help to improve our documentation for installation of development environment with XAMPP.

Task ✏️

• Go to https://docs.ushahidi.com/platform-developer-documentation/getting-started/setup_alternatives/xampp
• Follow the instructions and try to install the platform
• Document and write comments about the installation-process as comments below, it could be for example:
  • Confusing instructions
  • Errors you get that is not mentioned in the documentation
  • Do you get stuck somewhere and don't manage to get past a point in the documentation? Where is that?
  • Do you have to do things that is not mentioned in the documentation to make it work? Where and what did you do?
  • Anything else that comes to mind, suggestions, comments etc when reading through the docs.

Thank you for your time and help 🎉 🙏 🙇‍♀

Aha! Link: https://ushahiditeam.aha.io/features/PROD-189

[muchirijane]

Hey @Angamanga, could I please work on this as part of my outreachy contribution?

[Angamanga]

Thank you @muchirijane! Please go ahead :)

[muchirijane]

Thanks 💯
Hey @Angamanga, should I write my feedback as I create the PR, or I should take another step to create a .txt file.

[SaraLatif99]

Hi, Can I take this as part of Outreachy 2020 and hacktober first 2020 contributions?

[Angamanga]

@muchirijane You can write your suggestions here as a comment :)

[Angamanga]

@SaraLatif99 Yes, please go ahead :)

[muchirijane]

@Angamanga, I did a pull request an hour ago. Didn't know it was to be a comment. Oops.
#4092
Let me copy the information here.

[muchirijane]

The installation was done on windows and here are my suggestions and some parts that were a bit confusing.

• In the documentation configuring the API section, Change the DB_USER to root in the .env file there is DB_USERNAME listed instead. That's what I changed. Maybe that section could be updated in the documentation.
• When running composer migrate I got an error

composer migrate

php artisan environment:verify
Running OAuth key checks
Good job! Your OAuth keys are in the right place.
We will check the environment file next.
Running ENV configuration checks
DB_PASSWORD is missing in the environment or .env file.
Please set the password to connect to your database in the DB_PASSWORD key
Running DB connectivity verification
We were able to connect to the DB. Well done!

In EnvironmentVerify.php line 84: Verification Failed. Script PHP artisan environment: verify handling the verify event returned with error code 1 Script @verify was called via migrate

• Configure the platform/.htaccess file - I could not see this file, I created a .htaccess myself and copied the code in the documentation.
• Got stuck at this section : Windows: In the XAMPP control panel, click the "Config" button next to Apache and select "Apache (httpd.conf)". This will open an editor with the file. In my case, I thought it was checking the [ ] Apache but an editor didn't open.

• Suggestions - The last part can be a bit complex for someone who is a beginner in contribution. It would be helpful if the last part of the documentation could be turned into a video. The videos are really helpful especially since it's visual and you easily follow through the steps.

• A suggestion on the videos: Please increase the audio of the videos, the instructor seems to be far from the mic or audio equipment used. Apart from that, they were really helpful

• Overall the documentation is clear and the videos are even more helpful.

[SaraLatif99]

Thanks @Angamanga

[codedladiesinnovate]

@Angamanga please can I do this as part of my outreachy contribution?

[UdokaVrede]

Hi you are using an organization account to make this request, please recheck

…

On Sun, Oct 11, 2020 at 4:11 AM Coded Ladies Innovate Tech < ***@***.***> wrote: @Angamanga <https://github.com/Angamanga> please can I do this as part of my outreachy contribution? — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#3662 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/APFTMSHRM5NB3PNPAWY346TSKEO47ANCNFSM4IMG76YA> .

[amadikwajoyn]

Sorry @Angamanga I forgot to logout of the organization mail.
I'm Amadikwa Joy N, can I work on it

[codedladiesinnovate]

Sorry @Angamanga It was a mistake. I was meant to use Amadikwa Joy N.

[Angamanga]

@treasurechristain No problem! Please go ahead :)

[Sunairaa]

Hey @Angamanga can I work on it as an outreachy contribution? I followed the whole tutorial and found some improvements need to be done in the documentation but in the end, I did some fixes too again not able to run the code. so I have to choose a vagrant option which is working perfectly on my side. can I suggest some editing in it.?

[amadikwajoyn]

I think the above link is not correct because its taking me to empty page.
@Angamanga could the link below be the actual link?
https://docs.ushahidi.com/platform-developer-documentation/development-and-code/setup_alternatives/xampp

if yes, let me continue with the work

[amadikwajoyn]

Under Setting up the Platform API with XAMPP
Go to http://localhost and verify that you see the XAMPP welcome page.
should be Open your browser and type http://localhost

Apache and MySql not starting do

• click on Apache Config button

• from the dropdown menu, select Apache(httpd.conf)

• On the notepad window, click **ctrl + f ** on your keyboard

• Type 80 on the search bar to locate it in the file

• Replace 12.34.56.75:80 with 12.34.56.75:8080

• Replace Listen 80 with Listen 8080

• Replace Servername Localhost :80 with Localhost :8080 then save the file

• Goto Xampp Control Panel

• Click on Apache config button

• On the dropdown menu, select Apache(httpd-ssl.conf)

• On the notepad and click **ctrl + f ** on your keyboard

• Type 443 on the search bar to locate it in the file

• Replace Listen 443 with Listen 4343
  

• Replace <Virtualhost_default_:443> with Virtualhost_default_:4343>
  

• Replace Servername www.example.com:443 with Servernamewww.example.com:4343
  

In a Situation Where MySQL is not Working, do the following: -

• Select and click on MySQL Config
  

• Select my.ini
  

• On the Notepad window, find port=3306 and replace with 3307 .
  For password Section change port=3306 and replace with 3307
  

• Save the notepad document

• On the Xampp Control Panel

• Click on Xampp Config

• On the pop up dialog window, click on service and port setting
  

• On the Popup window, click on MySQL tab and replace 3306 with 3307
  

• Then save all changes and start apache

UNDER Configuring The API

• I suggest this should be rephrased from
  We will configure the API now. We will do this continuing working on the same terminal window that was opened in the previous steps.
  with
  We will configure the API now. Still working on the same terminal window that was opened in the previous steps.
  

• For windows, instead of Change the DB_USER to root it should be **Change the DB_USERNAME to root **
  

• Instead of Run composer install. Wait while composer installs all the dependencies it should be In the CMD/terminal Run composer install. Wait while composer installs all the dependencies

• Environment Verified Failed
  
  But I resolved it firstly by getting my github auth token
  

Then changed the memory limit of xampp phpini file

Inside the composer.json I add "nesbot/carbon": "2.41.0 as 1.39.0", and **"kylekatarnls/laravel-carbon-2": "^1.0.0" **

On the xampp shell, inside the project file location , I ran composer require nesbot/carbon:^1.24.1

Still on the CMD shell, I ran **composer update

**

Still on the CMD shell, I ran _**composer install

FROM Configure the platform/httpdocs/.htaccess file
I didn.t see any .htaccess rather I saw template.htaccess

And there is no .htaccess inside platform/.htaccess

Suggestion: The Instructions at Setting up the Platform client is not that clear because it's not at the beginners level to understand it easily.
And I suggest that some of the instructions will easily be understood with symbols or images for illustration.

I must say, the video is awesome and straight forward. but making a video that covers the instructions on how to configure the platform/.htaccess .

Thanks.

[amadikwajoyn]

@Angamanga This is what I came up with after going through #3662
Hope it's helpful enough.

[Angamanga]

@treasurechristain Thank you for your contribution 🙏