QuickFrame
QuickFrame Django Docs - v1.0.0
Installation

1. Download the Package

2. Unzip the Package

  • Extract the contents of the downloaded .zip file to a directory on your computer, Navigate to admin directory

3. Prerequisite

4. Install Node Modules

  • Navigate to the admin/ directory of Django version.
  • Execute:
    npm i or npm install

5. Compile and Generate Static Assets

  • Command: In the same directory, run:
    npm run build

    This command will create a production-ready css,js and other assets of your project in a dist directory, From where we are serving the assets to django server.

6. Install Python Dependenies

  • Note: Open new terminal in the same directory(/admin) for python and let the run other terminal to watch assets channges:
  • Virtual Environment: To create virtual environment type the following in the command prompt:
  • Windows:
    py -m venv myenv
  • Unix/MacOS::
    python -m venv myenv
  • Then you have to activate the environment, by typing this command:
  • Windows:
    myenv\Scripts\activate.bat
  • Unix/MacOS::
    source myenv/bin/activate
  • Once the environment is activated, you will see this result in the command prompt:
  • Windows:
    (myenv) C:\Users\Your Name>
  • Unix/MacOS::
    (myenv) ... $

5. Install Python Dependenies

  • Command:
    pip install -r requirements.txt 

    This command will install all dependencies in newly created venv.

6. Start in Development Mode

  • Command: To start the project in development mode, run:
    py manage.py runserver 

    This command will start the development server, allowing you to view and work on your project locally.