Quick Start

The easiest way to get familiar with 8base is to run a demo application in your workspace.

1. Login to 8base:

Follow the link to login to 8base.

2. Create a new workspace:

You can use an existing empty workspace. However, if your workspace has data we recommend creating a new one by clicking the current workspace name in the header and selecting "New Workspace".

3. Install 8base CLI (node.js is required):

npm install -g 8base

4. Clone the demo app github repo:

git clone https://github.com/8base/app-example.git

5. Import data schema and deploy backend logic:

cd app-example/server

# Login with CLI. 
# If you have multiple workspaces CLI will prompt you to select the empty one you created earlier.
# Note the API endpoint URL displayed after login - you will need it later.
8base login

# import data schema and sample data
8base import -f DEMO.json

# deploy backend logic
npm install
8base deploy

6. Run the front-end application:

cd ../client
npm install

You can now login into the demo app using your username and password.

We hope this guide helps you better understand how 8base works. Feel free to modify the data schema in your workspace, build new tables and screens to learn how to develop applications using 8base.

Windows users

In order to be able to specify environment variables (e.g. REACT_APP_8BASE_API_ENDPOINT) inline on Windows you can use cross-env:
npm install -g cross-env

This will allow you to run:

Quick Start

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.