A basic starting point for an Aptuitiv theme.
The goal of this theme is to be copied to another repository for the site you're working on. From there, you can install it on the website, and edit it as needed.
You'll want to create a new git repository for the site that this is being installed to. Copy the contents of this repo to that repo. That will allow you to make modifications that only affect that website.
From that folder, you'll need to install the dependencies, run an initial build, and set up FTP. You can set up FTP using create-ftp-env or by following the FTP section below. When prompted for credentials, you can find them in the CMS under Settings -> Domain / FTP / DNS.
npm install
gulp build
create-ftp-env
Before deploying, you'll want to log into the CMS for the new site and do the following. These prepare the CMS for deploying the theme files.
- Turn on SSL by enabling "My site supports SSL", "Entire public site is secure", and "Entire administration is secure" from Settings -> Security.
- Disable Cache under Settings -> Cache.
- Install the Theme configuration by uploading it under Design -> View Themes -> Update and continuing on the next page.
- Prime the Page Templates by visiting Design -> Templates.
- Edit the "Home" page to use the "One Column" Page Template from Content -> Pages.
- Delete the "Default" Page Template from Design -> Templates.
- Set the "Banner" Content Layout's available Content Areas to be only the "Banner" Content Area under Content -> Content Layouts -> Banner -> Edit this Content Layout.
- Set up Template Content Layout Assignments to map the "Banner" Content Layout to the "Banner" Content Area for the "One Column" and "Two Column" Page Templates under Content -> Page Settings -> Template Content Layout Assignments.
- Prime the Snippets by visiting Design -> Snippets.
- Prime the Navigation Templates by visiting Design -> Navigation -> Navigation Templates.
- Create a "Main" Navigation Menu using the "Main" Navigation Template and select "Show sub navigation all the time" from Design -> Navigation -> Navigation Menus.
- Create a "Footer" Navigation Menu using the "Footer" Navigation Template from Design -> Navigation -> Navigation Menus.
- Prime the Content Builder Elements by visiting Design -> Content Builder.
- Prime the Collection Widgets by visiting Widgets -> Collections -> Notifications.
- Prime the Form Templates by visiting Forms -> Templates.
- Prime the Search Templates by visiting Site Manager -> Search -> Templates -> Templates.
- Edit and save the Search Form under Site Manager -> Search -> Forms. This will generate the form fields.
- Set a sensible Admin Theme under Settings -> Admin Theme.
Deploy the theme files using the gulp deploy
command and wait until completed (~30 seconds).
To finish the installation, you'll need to configure some basic options of the theme.
- Update the Company Information under Settings -> Company Information.
- Configure Theme Settings under Design -> Theme Editor.
- Set the default Banner Image sizes under Settings -> Banner Images. Set these to 2000x1000, 1000x500, 500x250.
- Upload a Header logo or set the text logo under Settings -> Header.
- Update the Color Palette under Palettes -> Color Palette. Add "Primary" (#871E0F), "Secondary" (#591108), and "Typography" (#333).
- Update the Font Palette under Palettes -> Font Palette. Add "Montserrat" and "Open Sans" with default weights. Disable all of the System fonts under the "System" tab.
- Go through all of the Theme Styles from the Theme Styles tab and update all color references to use the Color Palette if matching one.
- Update Typography under Styles -> Typography to use "Open Sans" for the base font family and "Montserrat" for the heading font family.
You've now got an instance of Skeleton installed and configured on your new site. From here you can customize the styles in the Theme Editor or make template changes.
If you want to make changes, all you have to do is run gulp watch
while making all file changes. They will be deployed automatically.
We recommend using create-ftp-env for generating the .env
file automatically.
You can alternatively create a manual .env
file with the following data instead:
FTP_ENVIRONMENT = live
FTP_SERVER = ftp1.branchcms.com
FTP_USERNAME = my_ftp_username
FTP_PASSWORD = my_ftp_password