1 Minute Quick Start

This brief tutorial aims to give you a rapid taste of QOR5's capabilities in the shortest possible time. One standout feature of QOR5 is its "presets" module, which swiftly generates fully functional admin interfaces like those you see below.

To get started right away:

  1. Install the Command Line Tool: Run the following command to install the latest version of the QOR5 CLI tool:

    $ go install github.com/qor5/admin/v3/cmd/qor5@latest
    
  2. Launch QOR5: Execute the qor5 command:

    $ qor5
    

You'll be prompted to enter a Go package name.

And then there are these template options,

  • Admin: Content Management System
  • Website: Content Management System with Website Examples
  • Bare: Simplest Workable Web App

Here we select Admin, The tool will then create an admin app within your current working directory.

  1. Set Up the Database: Navigate to the newly created package directory and start the database using Docker Compose:

    $ cd <your_package_name>
    $ docker-compose up
    

This command launches the necessary database services

  1. Run the Admin App: Open a new terminal window and execute the following commands to load the development environment variables and run the admin application:

    $ source dev_env
    $ go run main.go
    

With these quick steps, you'll have a fully operational QOR5 admin interface up and running, showcasing the remarkable speed and efficiency at which QOR5 empowers you to build sophisticated web applications. Explore the interface to witness firsthand the extent of QOR5's power and versatility, all within just one minute!