lc-ui / lcui-quick-start

Clone to try a simple LCUI app

lcui-quick-start

(English/中文)

Clone and run for a quick way to see LCUI in action.

To Use

To clone and run this repository you'll need install the following tools on your computer:

• Git

• Node.js (which comes with npm)

• LCPkg:

  npm install -g lcpkg
  lcpkg setup

• LCUI CLI:

  npm install -g lcui

• CMake or XMake

Open your command line terminal and type the following command to clone this repository:

git clone https://github.com/lc-ui/lcui-quick-start

Go into the repository:

cd lcui-quick-start

Then run the following command:

# set up the development environment for project
lcui setup

# build project
lcui build

# Run project
lcui run

Other useful commands:

# Configure the compiler to compile in debug mode
lcui build --mode debug

# Use CMake to build this repository
lcui build --tool cmake

# Clean build folder before building
lcui build --clean

What's included

• Some resource files.
• Some scripts that make it easy for you to quickly build application.
• Configuration files for CMake and XMake build tools, You can choose one of them that you like.
• Simple data storage implementation in src/lib/store.c.
• .scss files for describe the user interface style.
• about component for display app infomation.
• home view that implements simple layout and interaction.

Project Structure

• app: contains the resource files required for the application to run. You can use it as the working directory of the application, and when you publish your application, you only need to package the files in that directory.
• build: contains build tool output files.
• scripts: contains build-related scripts and configuration files.
• src: contains the source code.
  • ui: contains source code related to the user interface.
    • stylesheets: contains the source code of stylesheets. You can put .scss files here, they will be compiled into css files and outputed to the app/assets/stylesheets directory at build time.
    • components: contains the source code of the components.
    • views: contains the source code of the views.
  • lib: contains the base library code.

License

CC0 1.0 (Public Domain)