Installation & Build

Info: Please note, the use of Node, Webpack & Gulp and their advanced settings are totally optional. You can use and customize the template without using them too.

We have used understandable and easy-to-understand instructions to help you install Mirbal- Django Admin & Dashboard Template in your project. Follow the below steps to get started.

1. Install Yarn and Node.js (if not already installed)

Prerequisite: Ensure Node.js and npm (Node Package Manager) are installed on your system. Make sure to use node version 22.*.
Command: If Node.js is not installed, download and install it from the website. npm comes bundled with Node.js.

2. Install Node Modules

Setup: Open your terminal or command prompt from the Mirbal_Django_v1.0.0/Admin folder.
Execute: Run the following command to install all the required Node.js packages and dependencies specified in the package.json file:
```
yarn
```
Explanation: This command will download and install all the necessary dependencies for your project, including build tools, libraries, and plugins, ensuring your development environment is set up correctly.

3. Create a Production Build & Libraries Folder

Command: After the dependencies are installed, generate a production-ready build by running:
```
yarn run build
```
Outcome: This command compiles and optimizes your assets, creating a distribution folder (`/assets`) that contains minified and ready-to-deploy files. It ensures your project is optimized for performance in a production environment.

4. Install Django

Prerequisite: Ensure Python and pip(Python Package Manager) are installed on your system. Make sure to use pip's latest version.
Virtual Env: Create and activate virtual env.
Command: To check if your system has Python installed, run this command in the command prompt:
```
python --version 
```
Outcome: If Python is installed, you will get a result with the version number, like this:

Python 3.13.2

If you find that you do not have Python installed on your computer, then you can download it for free from the following website: https://www.python.org/

Command: To check if your system has PIP installed, run this command in the command prompt:

pip --version

Outcome: If PIP is installed, you will get a result with the version number. For me, on a windows machine, the result looks like this:

pip 25.1.1 from c:\python39\lib\site-packages\pip (python 3.13)

If you do not have PIP installed, you can download and install it from this page:

https://pypi.org/project/pip/

Command(Windows): To create virtual environment, run this command in the command prompt:

py -m venv path/to/virtual_env

Command(Unix/MacOS): To create virtual environment, run this command in the command prompt:

python -m venv path/to/virtual_env

Outcome: It will create dir to given path in the command.

Command(Windows):Then you have to activate the environment, by typing this command:

path\to\virtual_env\Scripts\activate.bat

Command(Unix/MacOS): Then you have to activate the environment, by typing this command:

source path/to/virtual_env/bin/activate

Outcome:Once the environment is activated, you will see this result in the command prompt:

Windows:

(path/to/virtual_env) C:\Users\Your Name>

Unix/MacOS:

(path/to/virtual_env) ... $

Command:To install django and other packages, Navigate to 'Admin/' in the terminal and run this command in the command prompt:

pip install -r /path/to/requirements.txt

Command:After the dependencies are installed, start django server locally by running:

py manage.py runserver

Outcome:This command will start project on development mode. You can visit by http://127.0.0.1:8000/.