Quick start guide
For experienced developers, a list of tasks to get started with the framework as quickly as possible.
This guide will step through creating a new project using the BaseCMS Website Framework.
Dependencies
Install the Marko Web framework and the web CLI utility:
Required files
the BaseCMS Website Framework makes a couple of assumptions: You're running a website, and you intend for users to access it via a browser (rather than just being a headless API.)
To that end, the following two files must be created within your project:
The site CSS file
The site CSS file must be created at server/styles/index.scss
within your project.
The site JS file
The Vue.JS file must be created at browser/index.js
within your project:
Required environment variables
The following are the minimum required variables to use the framework. If you don't have these values available, feel free to reach out to us via support@parameter1.com and we can supply them!
Key | Type | Description |
| string | The BaseCMS tenant key |
| string | The BaseCMS site id |
| URI | The URI to use to connect to a BaseCMS GraphQL server. |
| URI | The URI to use to connect to a BaseCMS RSS server. |
| URI | The URI to use to connect to a BaseCMS OEmbed server. |
| URI | The URI to use to connect to a BaseCMS Sitemaps server. |
We recommend using Docker Compose and the envalid
package to manage environment variables within your project. This is also repackaged under the @parameter1/base-cms-env
package, which you can install with npm
Create an env.js
file:
Create a .env
file:
Creating a template
Create a server/templates/home-page.marko
template:
Configuring the framework
Create an index.js
file:
Starting it up
Run your site:
By default, your application will be available on localhost
on port 4008
. To override this, set the PORT
environment variable.
Last updated