Local installation guide
The tasks below will guide you through a local Litium installation, including the MVC Accelerator. The installation will be complete with ElasticSearch, Redis and XUnit test project configured. You can then proceed to the customization guide to try some common customizations for your installation.
The tutorial is tested in Windows only, it may work on additional platforms but this is currently not tested or supported.
Some tasks assume that a previous task has been completed (dependencies are presented in each tasks description), the recommended order to do them is listed below.
If something is not working in your setup it may be because of a missed step, please double-check the guide again and if you have any questions please ask them in Litium forum.
Preparations
Check that you have completed the requirements below before you start.
- Install Docker Desktop so that you can run containers
- Configure access to Litium's Docker images so that you can download the required images from Litium
- Litium is only distributed through NuGet, so you also need to configure the Litium NuGet feed (requires a Litium Docs account with partner privileges).
- Install Visual Studio 2022 for the development (older versions will not work)
- It is also recommended to use version control to track modifications, see Litiums recommended branching strategy for recommendations on how to work with branches for easier code maintenance.
Setup and configuration
The steps below will give you a full production-like installation of a new Bookstore website. You will have a working site already after the Setup Litium MVC Accelerator step, but it is recommended to do all steps to get a local development environment that is as similar as possible to the production environment where the site will be hosted later.
- Certificate
- Setup Docker
- Setup Litium MVC Accelerator
- Configure Litium search
- Configure payment and shipment apps
- Configure Redis
- Configure SMTP
- Configure test project
When the setup and configuration is done it is time to do some common customizations on your Bookstore. Head on over to the Customizations guide to get started.
Configure a local SSL-certificate to use through the tutorial
Configure and start the containers required by the Litium installation
Create the Accelerator solution and deploy a new Bookstore website
Connect Litium to the Elasticsearch container.
Connect the Litium apps running in separate containers
Connect Litium to the Redis container
Configure Litium to use the test tool MailHog to test e-mail
Configure the XUnit test project to automatically test Litium business logic.