Get Started — Introduction
Welcome to platformOS! Our Get Started guides will walk you through the steps of building a sample site or app on platformOS. They include detailed explanations for each step, example code, tips and best practices on development workflow and QA, and links to learn more.
What you need to know
Command line knowledge is required to navigate through the project folder structure and to deploy the changes you make locally to the server.
We recommend using a version control system. Internally, we use GitHub to host and collaborate on our git repositories. You can choose other version control systems, or decide to go without any: all that is required is your codebase and an Instance you can sync/deploy to.
GraphQL is a query language that will help you build your back-end and needed APIs. It allows to manage data for your application, store and read database records and more. In the Get Started guide you will be guided through writing your first queries, so don’t worry!
Liquid is a template language that allows you to build dynamic pages and provide dynamic configuration. In the Get Started guide we will be using it to server-side render data and to manage how the page behaves depending on user's action. You can check out the following articles but you can also learn while doing – it should be simple to understand.
- A Complete Guide to Liquid Markup by the platformOS team
- Learning Liquid
- SHOPIFY LIQUID: Theme Programming for Beginners
YAML allows you to store complex data in a human-readable format. We will be using it for building our databases, set some simple configuration, and optionally to store the translation strings for multilanguage webstites.
Not sure where to start?
Let’s build a simple website together! If you are new to platformOS, we propose that you start with a simple course that we’ve prepared.
You will learn how to set up your environment, get a starter codebase, and deploy everything to your platfromOS instance. Next, you’ll build a simple to-do app using all of the core platformOS concepts.
Ready? Let’s learn how to install and configure your development environment.
- Go to the Partner Portal and sign up
- Create new instance in the Partner Portal
- Install pos-cli
platformOS command-line interface is distributed through NPM.
npm install -g @platformos/pos-cli
- Create an empty folder for your project
- Navigate to the project's folder in the command line
- Initialize the platformOS directory structure
- Authenticate your environment
pos-cli env add <environment> --email <your email> --url <your instance url>
- Upload your code to the instance
pos-cli deploy <environment>
- Upload code changes automatically when you save the file
pos-cli sync <environment>
Learn the core concepts
- Developement workflow
Learn the steps needed to deploy your code to a platformOS instance.
- Codebase structure
A detailed walkthrough of the directories and files required to work on the platform.
- platformOS Command Line Interface
Check out how to use the command line to interact with your instance.
- Routing and templates
Step-by-step guide on how the routing and creating subpages work on platformOS.
Learn how to define models with properties and persist the data in it.
The platform supports and encourages building modular codebases. This guide will show you how to do that.
- Data management
If you need to import or export previously prepared data, this is how you can do it.
- Effective Development Using the pos-cli
A deep-dive into clever techniques for everyday development.
Still have questions?
Our community can help! The platformOS community is open to all users to share the experience and knowledge gathered from working on platformOS-specific projects.