# Installation

# Install Using Composer

To install UnoPim using Composer, use the following steps:

  • Choose the directory where you want to install UnoPim. Open your terminal and navigate to this directory.

  • If you have downloaded the zip file from the Git repository, extract the files into your desired directory and run the following command to set up the project:

    composer create-project

  • Otherwise, to directly install UnoPim, run the following command in your terminal:

    composer create-project unopim/unopim

  • Run the following command to complete the installation:

    php artisan unopim:install

    WARNING

    During the installation process, if the .env file doesn't exist, the installer will prompt you to provide the necessary information.

    • Follow the prompts during the installation process to provide the following details:
    - Please Enter the APP URL :
- Please Enter the Application Name : 
- Please select the default locale :
- Please enter the default currency :
- Please choose the Allowed Locales for your channels :
- Please choose the Allowed Currencies for your channels :
- Please select the Database Connection :
- Please enter the Database Host :
- Please enter the Database Port Number :
- Please enter the Database Name :
- Please enter the Database Prefix :
- Please enter the Database Username :
- Please enter the Database Password :
    • For Create your admin credentials:
    - Enter the Name of Admin User :
- Enter the Email address of the Admin User :
- Configure the Password for admin user :

# Installation with Docker

If you have Docker/Docker Compose installed, follow these steps:

  1. Clone the repository:

    • HTTPS: git clone https://github.com/unopim/unopim.git
    • SSH: git clone git@github.com:unopim/unopim.git

  2. Enter the directory:

    cd unopim

  3. Start the Docker containers:

    docker-compose up -d

    This will pull the necessary images and set up the environment. Once running, access the application at:

    • Application: http://localhost:8000
    • MySQL: http://localhost:3306

Note:
If MySQL is already running on your system, change the MySQL port in the docker-compose.yml and .env files.
Run docker-compose up -d again to apply changes.

# Start Using UnoPim

# On a Production Server

To access UnoPim on a production server, open your domain in a web browser. For example:

https://example.com/

# On Your Local Server

To access UnoPim on your local server, follow these steps:

  1. Configure your HTTP server to point to the public/ directory of the project.

  2. Run the following command:

    php artisan serve

  3. Open your browser and access the provided local server URL.

← Packages →