Skip to content
Materia Server is the core of Materia. It handles your Materia Application and host them anywhere.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
docs
scripts
src
templates/deploy
.dockerignore
.editorconfig
.gitignore
.npmignore
.travis.yml
CHANGELOG.md
Dockerfile
ISSUE_TEMPLATE.md
LICENSE.md
README.md
install_electron.sh
materia
package.json
tsconfig.json
tslint.json
yarn.lock

README.md

Build Status npm version dependencies Status

Materia Server

Materia Server is the core of Materia. It handles your Materia Application and host them anywhere.

Materia logo

Installation

You can install Materia Server globally using NPM:

$ (sudo) npm install -g @materia/server

or yarn:

$ (sudo) yarn global add @materia/server

then you can use Materia Server in 3 ways:

  • CLI Interface,

  • Javascript interface,

  • HTTP Admin API.

CLI Interface

Manipulating the server

Start the server

$ materia start

Basic information

Get the current version of Materia Server

$ materia version

You can see more information in the Materia documentation.

The guide to use materia deploy

Javascript Interface

The API Reference is available on getmateria.com/docs/api-reference.

You can include these object (using require()) to create a Materia Application and save it on the Filesystem.

HTTP Admin Interface

The API reference is available here.

To interact with your running server through the HTTP Admin API, you first need to authenticate with your root password to retrieve your admin access token.

Your admin token has to be used as Bearer token. You can then use all the protected http endpoints to model your application.

Licensing

Materia Server is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.

You can’t perform that action at this time.