How to Install and Run the Project

0. Check if you have the tools needed for running this Laravel project.

• Make sure that your machine has PHP, Composer, and the Laravel installer installed. If thats not the case then check the information here.

1. Clone the Repository

• Clone this repository to any location of your choice.

2. Access the Cloned Repository

• Open a terminal in the cloned repository directory.
  • Alternatively, if you're using a GUI, navigate to the folder and open a terminal there.

3. Install Dependencies and Build the Project (Update 20/01/2024)

(I noticed there were some setup commands that were missing here in the instructions so I edited the Readme to fix the error it causes not using them.)

• Run the following commands in your terminal:
  • composer install: It install all the dependencies that Laravel uses
  • composer run setup: Runs the necessary commands that setup the project to be ready to run, like the .env file and other configurations
  • npm install: Installs the required dependencies for Vite.
  • npm run build: Builds the project.

4. Run the Application

• To run the application, use the command: composer run dev.
• The app should now be accessible at localhost:8000.

5. Running in Production

• If you need to run the application in production, consider using Nginx or Apache.

Note: You will need to register when first entering the application.

Troubleshooting "php artisan serve" Error

If you encounter the following error:

php artisan serve (Failed to listen on 127.0.0.1:8000 (reason: ?))

It might be caused by a misconfigured PHP installation. You can troubleshoot it as follows:

Steps to Fix:

1. Find the location of your php.ini file:
   • Run php --ini in the terminal and navigate to the directory.
2. Open the php.ini file and look for the variables_order directive.
3. Change its value to:

   variables_order = "GPCS"

4. After making the change, restart your terminal. If necessary, restart your server or your computer.

This should resolve the issue.

Why This Works:

Laravel uses DotEnv to fetch environment variables instead of relying on PHP's environment variables. This configuration change ensures compatibility.

---

About Laravel

Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:

• Simple, fast routing engine.
• Powerful dependency injection container.
• Multiple back-ends for session and cache storage.
• Expressive, intuitive database ORM.
• Database agnostic schema migrations.
• Robust background job processing.
• Real-time event broadcasting.

Laravel is accessible, powerful, and provides tools required for large, robust applications.

Learning Laravel

Laravel has the most extensive and thorough documentation and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.

You may also try the Laravel Bootcamp, where you will be guided through building a modern Laravel application from scratch.

If you don't feel like reading, Laracasts can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.

Laravel Sponsors

We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the Laravel Partners program.

Premium Partners

• Vehikl
• Tighten Co.
• WebReinvent
• Kirschbaum Development Group
• 64 Robots
• Curotec
• Cyber-Duck
• DevSquad
• Jump24
• Redberry
• Active Logic
• byte5
• OP.GG

Contributing

Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the Laravel documentation.

Code of Conduct

In order to ensure that the Laravel community is welcoming to all, please review and abide by the Code of Conduct.

Security Vulnerabilities

If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [email protected]. All security vulnerabilities will be promptly addressed.

License

The Laravel framework is open-sourced software licensed under the MIT license.