LiteCart is a lightweight e-commerce platform for online merchants. Developed in PHP, HTML 5, and CSS 3.
LiteCart is a registered trademark, property of founder T. Almroth - LiteCart AB.
For an updated version of the upgrade documentation, visit How To Upgrade.
What you need:
- An Apache2 web server running PHP 8.0 or higher. Latest stable PHP release recommended for best performance.
- A MySQL 8.0+ or MariaDB 10.4+ database.
Please note running your own website requires some common sense of web knowledge. If this is not your area of expertise, ask a friend or colleague to assist you.
-
Connect to your web host via FTP using your favourite FTP software.
-
Transfer the contents of the folder public_html/ in this archive (yes the contents inside the folder - not the folder itself). Transfer it to your website root directory. Using subdirectories is supported but not recommended.
```text Examples: * /var/www/ * /home/username/public_html/ * C:\xampp\htdocs\ ``` Paths are machine specific, ask your web hosting provider if you are uncertain where this folder is. -
Point your web browser to the URL of your website followed by the subfolder
install/e.g.http://www.mysite.com/install/. If you placed LiteCart in a subfolder of the web root, the path should be something likehttp://www.mysite.com/litecart/install. The installation page should now load. -
Carefully read the instructions on the page. Fill in your details for database, region, etc. Click the Install button when you are ready.
If everything went well LiteCart should be successfully installed.
For community written installation instructions see How To Install.
To get your store up and running, see our step list for best practice.
All paths below are relative to public_html/ (the document root).
public_html/
├── assets/ - Client-side third party libraries (javascripts, stylesheets, fonts)
│ ├── litecore/ - LiteCore JavaScript and stylesheet framework
│ ├── jquery/ - jQuery 4+ JavaScript DOM library
│ ├── trumbowyg/ - WYSIWYG JavaScript editor library
│ └── chartist/ - Chart library
├── backend/ - Admin panel (path controlled by BACKEND_ALIAS in config.inc.php)
│ ├── apps/ - Backend applications (catalog, orders, customers, settings, modules, etc.)
│ ├── mcp/ - Backend MCP tools (JSON-RPC server)
│ ├── pages/ - Backend page controllers (login, about, search)
│ ├── partials/ - Backend UI components
│ ├── routes/ - Backend URL routing
│ ├── template/ - Backend HTML/CSS/JS/LESS template
│ └── widgets/ - Dashboard widgets (orders, stats, graphs, addons, discussions)
├── frontend/ - Storefront
│ ├── mcp/ - Frontend MCP tools (JSON-RPC server)
│ ├── pages/ - Frontend page controllers (product, category, checkout, account, etc.)
│ ├── partials/ - Frontend UI components (site_header, site_footer, navigation, boxes)
│ ├── routes/ - Frontend URL routing
│ └── templates/ - Frontend template themes
│ └── default/ - Default theme
│ ├── css/ - Compiled stylesheets (CSS)
│ ├── fonts/ - Fonts
│ ├── images/ - Theme images
│ ├── js/ - JavaScripts
│ ├── less/ - Leaner Style Sheets (LESS) source files
│ ├── emails/ - Transactional email templates
│ ├── layouts/ - Visuals for content surroundings
│ ├── pages/ - Visuals for pages
│ └── partials/ - Visuals for partials
├── includes/ - Core application logic
│ ├── abstracts/ - Base classes (abs_module, abs_modules, abs_reference_entity)
│ ├── clients/ - Service clients (HTTP, SMTP)
│ ├── entities/ - Data entities (product, order, customer, etc.)
│ ├── functions/ - Helper functions, called via f::name()
│ ├── modules/ - Plug 'n play modules
│ │ ├── checkout/
│ │ ├── customer/
│ │ ├── order/
│ │ ├── order_total/
│ │ ├── shipping/
│ │ ├── payment/
│ │ └── jobs/
│ ├── nodes/ - Static service nodes (database, session, cache, settings, events, etc.)
│ ├── references/ - Read-only factory model reference objects
│ └── streams/ - Stream wrappers (app://, storage://)
├── storage/
│ ├── cache/ - Application cache
│ ├── downloads/ - Downloads storage
│ ├── images/ - Image storage
│ ├── logs/ - Application logs
│ ├── uploads/ - WYSIWYG uploads
│ ├── vmods/ - Virtual modifications and virtual file system
│ └── config.inc.php - Application configuration
├── install/ - Installation wizard, migrations, and country configs
├── tests/ - Platform tests (entity CRUD and integration tests)
├── vendor/ - Server-side third party libraries (Composer)
└── index.php - Main application entry point
Make sure you have a good understanding of LiteCart's platform model.
- Create a New Page
- Create a Box
- Create a Backend App
- Create a Backend Widget
- Change the Look of Your Store
- Create a Template
- Create a Regional Installation Package
- Create a Customer Module
- Create an Order Module
- Create an Order Total Module
- Create a Shipping Module
- Create a Payment Module
- Create a Job Module
- Create a vMod™ (Virtual modification technology by LiteCart)
- Create an Entity
- Premium API
- How to Create an A/B Test
Navigate to the folder ~/frontend/templates/ and you will find all HTML content and CSS files to edit. If you chose LESS instead of CSS during install you will need edit the .less files instead of .css and use a LESS compiler to build new CSS versions. We recommend downloading our Developer Kit that has a preconfigured LESS compiler and JavaScript minifier.
See our wiki article How To Create a Template.
See CONTRIBUTING.md for guidelines on contributing to the project.
This project is licensed under the terms specified in LICENSE.md.