Project Setup
Follow the instructions bellow to setup the project locally
Follow these steps to install and run Mintlify on your operating system:
Step 1: Clone the repository
Step 2: Navigate to project’s root directory and create .env
file.
Open .env
file and adjust environment variables.
Set application URL to be:
- http://localhost or http://larastore.test (You will need to update
hosts
file) If you are setting the project up with docker. - http://localhost:8000 (Port might change if port 8000 is occupied) if you are setting the project up without docker.
If you want to use MySql instead of sqlite, modify the DB_*
variables.
Step 3: Setup the Project
There are two options to setup the project:
- Setup with docker (using laravel sail)
- Or setup manually
You don’t need to have php
, composer
or npm
commands available in your machine. You only need docker.
This command will install composer packages using docker and you should see vendor
folder appearing in your file system.
Start the project
The following command will start necessary docker containers and start the project at http://localhost port 80. -d
flag will run the containers in detached mode.
Stop the project
If you started the project without -d
flag you can simply hit ctrl + c
(cmd + c
on Mac) to stop running containers. However if you started the project with -d
you need to execute the following commands to stop running containers.
If you want to drop all containers, execute
Running terminal commands
Whenever you need to execute terminal commands (such as artisan commands) you need to execute them from inside docker container.
The command bellow will get you inside the docker container.
./vendor/bin/sail up
If you started docker containers without -d
you probably need to open a new terminal and execute the following command there.
Install npm dependencies
Start Vite Server
You don’t need to have php
, composer
or npm
commands available in your machine. You only need docker.
This command will install composer packages using docker and you should see vendor
folder appearing in your file system.
Start the project
The following command will start necessary docker containers and start the project at http://localhost port 80. -d
flag will run the containers in detached mode.
Stop the project
If you started the project without -d
flag you can simply hit ctrl + c
(cmd + c
on Mac) to stop running containers. However if you started the project with -d
you need to execute the following commands to stop running containers.
If you want to drop all containers, execute
Running terminal commands
Whenever you need to execute terminal commands (such as artisan commands) you need to execute them from inside docker container.
The command bellow will get you inside the docker container.
./vendor/bin/sail up
If you started docker containers without -d
you probably need to open a new terminal and execute the following command there.
Install npm dependencies
Start Vite Server
php
, composer
and npm
commands available in your terminalInstall Dependencies
Start the application
If you are setting up the project with docker you need to execute every command from inside the container.
Step 4: Generate application key
Step 5: Create storage link
Step 6: Run Migrations
Application URL
Now you can access the application in your browser
- http://localhost or http://larastore.test If you set up the project with docker.
- http://localhost:8000 (Port might be different if port 8000 was occupied) if you are set up the project without docker.