If you don't have a free Airship account yet, sign up for one. Once you have an account in the Skyport Developer Portal, you will be able to create and manage all your Airships. Launch a new Airship Site, then follow the link on your confirmation email to login to the Airship Admin panel. The Airship Admin panel is the CMS where you would manage your users (accounts for content creators or other developers), and design the structure of the site.
Plan out the sitemap and sketch quick wireframes for each unique page or collection in your project. If you need to see some examples, we have some demo use cases to share that are schemas from our own actual projects.
In Airship CMS, define the dynamic datafields needed for each Page and Collection. Remember that any datafield that you define directly maps to a piece of content or value that you would want your Content Creator to be able to update by themselves at any time.
If you aren't sure about the exact datafields you need, don't worry! Just start with the Landing Page and the example Collection that are defined for you. You can make changes and additions to the site at any time.
Once you are done setting up the site structure, add some demo content to each Page and add some placeholder items to each Collection. Be sure to do this step, so you will be able to see content on the scren when you are developing your project.
Install the Airship Launcher so you have access to the command line tools necessary for serving site content when you are developing locally.
You can skip this step if you already have airship launcher installed. Not sure? Type this in your terminal. If you see a version number, you are already good to go!
/bin/sh -c "$(curl -fsS https://install.airshipcms.io)"
Slow Install For those of you that want to see exactly what tools are being installed on your machine, read and follow the instructions at install.airshipcms.io.
Create a new empty directory for your project.
mkdir ~/MyFirstAirshipSite cd ~/MyFirstAirshipSite
If you use an SCM like Git (you should be!), then you can initialize this directory as a versioned project.
Inside of the ~/MyFirstAirshipSite directory, run this command (replace "yourairshipsubdomain" with your actual subdomain:
airship login yourairshipsubdomain
A browser window will pop up prompting you to login through Auth0 (our authentication provider). Once you log in successfully, you can close the browser window.
Once you are logged in, you need to sync your local project directory with the templates and files generated when you set up your site schema in Airship CMS. All airship commands should be done inside of your ~/MyFirstAirshipSite directory.
This command will generate a compartments directory containing critical Airship files that are necessary for building out your project templates. Running airship land will overwrite any files in the compartments directory, so please be very aware of when you run this command, and back up local files often! You will typically only need to airship land once per project during this setup phase. After your files are landed, you will be working locally on your project (and hopefully backing up code to an SCM), so you probably won't need to land the project again.
Now that you have synced all the files that were on the server, you can start developing!
You can start a local development server by using the Airship Launcher serve command.
You must leave this terminal open during development in order to access the local server, so you probably want to have at least two terminals open.
While the server is running, you can test out your site locally by navigating to localhost:9001.
The local development site pulls live content from the Airship database, so internet access is required.
You can add and update layouts, templates, and media assets during development, refresh the local server, and see the local changes right away.
Once a version of your site is ready to launch to production, run this command to deploy your templates and assets:
In your terminal, you will be presented with a preview of the actions that will occur when you run airship launch. Review the actions carefully before confirming, then enter y or yes.
Once you confirm and launch, then your site will be updated immediately!
Part of your regular development workflow probably involves using a Source Code Management tool like Git, where you can maintain your own versioning and backups. SCM tools work seamlessly with Airship projects. You can put any files you want in your main repository directory, as long as the compartments directory maintains proper files and structure.
Another good practice during development, is to have a staging environment. This is relatively simple with Airship. Just create a new Airship site for each environment that you need for Quality Assurance, User Acceptance Testing, and Production. For sites that have a more complex eCommerce functionality that requires a lot of testing, we have a separate staging server that is set to the development mode of Stripe.
Command Line Tools
Fully-Hosted Files & Assets
Simple, Secure Content Management
No Credit Card Required.