Skip to main content

Quickstart

Getting Started with CockpitNest​

Follow these simple steps to get your CockpitNest project up and running in no time.

Prerequisites​

Before you begin, ensure you have the following installed on your development machine:

  • Node.js (version 20.x or higher)
  • npm (Node package manager)
  • Git (optional, for version control)
  • PHP (version 8.2 or higher, for Cockpit CMS)
  • Composer (for running Cockpit CMS)
  • MonggoDB (Optional, supported database for Cockpit CMS)

Clone the Repository​

Start by cloning the CockpitNest repository from GitHub:

clone repository
git clone https://github.com/BimaBizz/cockpitnest.git
cd cockpitnest

Install Dependencies​

Install the required dependencies for both the Next.js frontend

Install Next.js Dependencies​

install dependencies NextJS
cd cockpitnest
npm install

Install Cockpit CMS​

  1. Download the latest version of Cockpit CMS from the official repository or directly from the Cockpit CMS website.
  2. Extract the files into the your htdocs directory.
  3. Ensure the storage and config directories are writable.
  4. Go to url of your cockpit cms /install

Configure Environment Variables​

You'll need to set up environment variables for the frontend.

Frontend (.env)​

Rename .env_sample to .env on cockpitnest directory and fill your environment variables:

frontend/.env
NEXT_HOST=http://localhost/cockpit-pro
NEXT_ASSETS_URL=http://localhost/cockpit-pro/storage/uploads
NEXT_MENU_NAME=bizzcode


NEXT_PUBLIC_ASSETS_URL=http://localhost/cockpit-pro/storage/uploads
NEXT_PUBLIC_HOST=http://localhost/cockpit-pro
NEXT_PUBLIC_UR_DOMAIN=https://yourdomain.com
NEXT_PUBLIC_COCKPIT_URL=localhost

Backend (Optional - config/config.php)​

Edit the config.php file in the backend/config directory to set up your database connection and other settings:

backend/config/config.php
# use mongodb as main data storage
'database' => [
    'server' => 'mongodb://localhost:27017',
    'options' => [
        'db' => 'cockpitdb'
    ]
],

Start the Development Servers​

Start the Cockpit CMS Backend​

Navigate to Cockpit CMS

This will start Cockpit CMS on ``.

Start the Next.js Frontend​

Navigate back to the frontend directory and start the Next.js development server:

start your CockpitNest
npm run dev

This will start the Next.js frontend on http://localhost:3000.

Access Your Project​

  • Frontend: Open your browser and navigate to http://localhost:3000 to view your site.
  • Backend: Access the Cockpit CMS admin interface at ``.

Deploy Your Project​

When you're ready to deploy, follow these steps:

Build the Next.js Frontend​

build NextJS frontend
npm run build
npm run start

Deploy the built project to your preferred hosting provider.

Deploy Cockpit CMS​

Follow the standard procedure to deploy Cockpit CMS on your server, ensuring all configurations are properly set up.