Skip to content

Slicknode Quickstart

To get started with Slicknode sign up for a free Slicknode account:

Sign up for free (No credit card required)

Installation

The Slicknode CLI can be installed via the terminal using npm. (How to get npm?)

npm install -g slicknode

Usage

Initialize

To create a new Slicknode project, navigate to the folder where you want to create your new project and run:

slicknode init my-fancy-project

# Change into the newly created project directory
cd ./my-fancy-project

Info

This will ask for your Slicknode login information when run for the first time. Enter the login information that you used when you signed up.

Create a module

Modules are the top level building blocks that let you organize your project in a modular way. Put each functionality of your project in a separate module. That way they can easily be reused in other projects.

To create a blog for example, run:

slicknode module create blog

It will suggest a namespace and the label that will be displayed in the data browser. Just hit enter to use the suggested values for now.

This will create the following file structure in your project folder:

modules/
    blog/
        slicknode.yml
        schema.graphql
slicknode.yml

Model your schema

You can model your schema using the GraphQL SDL.

In your favorite editor, open the file modules/blog/schema.graphql and enter your schema, for example:

"""
A blog article
"""
type Blog_Article implements Node & TimeStampedInterface {
    id: ID!
    title: String!
    slug: String! @unique
    text: String! @input(type: MARKDOWN)
    author: User!
    createdAt: DateTime!
    lastUpdatedAt: DateTime
    comments: [Blog_Comment!] @relation(path: "Blog_Article=article.Blog_Comment")
}

"""
Comments for blog articles
"""
type Blog_Comment implements Node & TimeStampedInterface {
    id: ID!
    text: String! @input(type: TEXTAREA)
    author: User
    article: Blog_Article!
    createdAt: DateTime!
    lastUpdatedAt: DateTime
}

Save the file and check if you have any errors in your project by printing the project status. Run the status command from the project folder:

slicknode status

Deploy

To deploy the changes to the cloud, simply run:

slicknode deploy

Now you have a production ready GraphQL backend and a fully functional CMS.

Explore

To explore your newly created GraphQL API, open the playground:

slicknode playground

This will open the GraphiQL playground for your API. (It might ask you for your login credentials)

To open the CMS data browser of your project:

slicknode console

Show the GraphQL endpoint that you can use with your GraphQL clients:

slicknode endpoint

Next Steps

Explore the full potential of Slicknode by using the rich feature set. Here are a few topics that can get you started:

  • Data Modeling: Learn how to model the data for your application
  • Client Setup: Connect your frontend application with the Slicknode server
  • Writing Extensions: Write custom extensions to add any API and database to your application
  • Auth: Secure your application and write complex permission rules that span multiple tables.