Welcome to Filmlog, a comprehensive movie tracker built on Laravel 9. This README provides a structured step-by-step guide to help you set up and enjoy the application.
Download & Extract: Download the archive and extract all its contents into the directory of your website where you wish to host Filmlog. Navigate to Directory: Open your terminal and navigate to the directory where you've extracted the contents.
Composer Packages:
- Run the command
composer install
to install all necessary Composer packages.
Node Packages:
- Execute
npm install
to install all Node packages. - Follow it up with
npm run dev
to build them.
- Environment File: Create a copy of the
.env.example
file and rename it to.env
. - OMDb API Key: Obtain an OMDb API Key from https://www.omdbapi.com and set it in the .env file as the OMDB_API_KEY value.
- Database Setup:
- If you haven't already, create a new database for the application. It's recommended to use utf8mb4_unicode_ci as the database collation.
- Update the .env file with your database credentials.
- Migrations: Run the command
php artisan migrate
to set up the database structure. - Application Key: Generate a unique application key by executing php
artisan key:generate
.
- Document Root: Ensure the public folder is set as your root directory. If you're running the application locally, this step might not be necessary. However, if you're using a web host, update the document root from CURRENT_PATH to CURRENT_PATH/public.
- Local Hosting: If you're hosting the application locally, run
php artisan serve
to start it. - Deployment Considerations: When deploying to a public domain:
- In your .env file set
APP_ENV=production
andAPP_DEBUG=false
- In your .env file set
Now that you've successfully set up Filmlog, dive in and enjoy tracking your favorite movies!
If you want more, create a .env.testing
file, based on your .env
file - consider to change your database configuration to not overwrite your existing database.
Then run your tests with the command php artisan test
.