getting_started

Documentation

Index

• Variables

Variables

var OneMinuteQuickStart = Doc(
	Markdown(`
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](/samples/presets-detail-page-cards/customers) 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/docs/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.

3. **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

4. **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!

`),
).Title("1 Minute Quick Start").
	Slug("getting-started/one-minute-quick-start")

var WhatIsQOR5 = Doc(
	Markdown(`
QOR5 is a Go library to build web applications.
different from other MVC frameworks. the concepts in QOR5 is **Page**, **Event**, **Component**.
and doesn't include Model.

A Page composite different kinds of Components, and Components trigger Events.
A Page contains many event handlers, and renders one view, and event handlers reload the whole page,
Or update certain part of the page, Or go to a different Page.

QOR5 is opinionated in several ways:

- It prefers writing HTML in static typing Go language, rather than a certain type of template language, Not even go template.
- It try to minify the needs to write any JavaScript/Typescript for building interactive web applications
- It maximize the reusability of Components. since it uses Go to write components, You can abstract component very easy, and use component from a third party Go package is also like using normal Go packages.
- It prefers chain methods to set optional parameters of Component
- It uses [Vue](https://vuejs.org/) js under the hood. and only Vue Component can be integrated

`),
	utils.Anchor(H2(""), "Hello World"),
	Markdown(`
Here is the most sample hello world, that show the header with Hello World.
`),
	ch.Code(generated.HelloWorldSample).Language("go"),
	Markdown(`
~H1("Hello World")~ is actually a simple component. it renders h1 html tag. and been set to page body.

The above is the code you mostly writing. the following is the boilerplate code that needs to write one time.
`),
	ch.Code(generated.HelloWorldMuxSample1).Language("go"),
	ch.Code(generated.HelloWorldMuxSample2).Language("go"),
	ch.Code(generated.HelloWorldMainSample).Language("go"),
	utils.DemoWithSnippetLocation("Hello World", examples_web.HelloWorldPath, generated.HelloWorldMainSampleLocation),

	Markdown(`
If you wondering why ~H1("Hello World")~ and how this worked, Please go ahead and checkout next page
`),
).Title("What is QOR5?").
	Slug("getting-started/what-is-qor5")