Skip to main content

Installation

Installation guide​

Prerequisites​

Ensure the following software is installed on your machine before proceeding:

  • PHP 8.x: The project requires PHP version 8 or higher.
  • Composer: For managing PHP dependencies.
  • Node.js and npm: Required for handling JavaScript dependencies.
  • Database (MySQL or compatible): You need a running database instance to store application data.

Steps to Install the Project​

1. Clone the Repository​

First, clone the project repository from Bitbucket. After cloning, navigate into the project directory.

git clone https://[email protected]/elizza-fine-jewellery/flux-crm.git flux-crm
cd flux-crm

2. Set Up Environment Variables​

Create the environment configuration by copying the example file. This file contains all the necessary settings such as database credentials and application-specific options. You can do this by duplicating .env.example and renaming it to .env.

Once the .env file is created, open it in a text editor and update the database information (name, username, password, etc.) to match your local or development environment.

cp .env.example .env

3. Install Dependencies​

Use Composer to install the PHP dependencies required by the project. Additionally, use npm to install all JavaScript dependencies needed for front-end operations.

composer install
npm install

4. Migrate and Seed the Database​

Now that the environment is configured, you can set up the database. Run the database migrations to create all the necessary tables. Afterward, optionally run the seeders to populate the database with initial or test data if required.

php artisan migrate
php artisan db:seed

5. Generate the Application Key​

To secure the application, generate a new encryption key. This key will be used to encrypt sensitive data in the application, and it is stored in the .env file.

php artisan key:generate

6. Run the Application​

Once the above steps are completed, you can start the application. Depending on your setup, you can use either PHP's built-in development server or a specific command to start the application.

php artisan serve

If the system is set up correctly, the application should be running locally and accessible via a browser.

Optionals​

In your .env file you can configure some optional parameters.

  1. Deactivating protection of forms by recaptcha:
RECAPTCHA_ACTIVE=false
  1. If you want to activate Google Recaptcha then you can get the keys from https://www.google.com/recaptcha/about/ login with your Google account or create one and then create a project.
RECAPTCHA_SITEKEY="your_recaptcha_site_key"
RECAPTCHA_SECRET="your_recaptcha_secret"
  1. Using google analytics, you can get the key from https://analytics.google.com/ and follow the same steps as with Google Recaptcha.
ANALYTICS_KEY="your_analytics_key"