Skip to main content

Installation

info

At this time, Adminmate is only compatible with MySQL, PostgreSQL, SQLite & MongoDB databases. More database compatibility is soon to come.

To start with Adminmate, you need to start by logging in & creating a new project here: https://app.adminmate.io/new

You will be asked to choose a project name (that can be changed later) and a database type between the ones available.

Once done, you will be given a Project ID & a Secret Key. Please keep these credentials secret as they allow a proper and encrypted communication between your admin back and the frontend dashboard.

At this stage you will have two solution to install the Data API, use the installation command we provide (recommended) or install it manually.

The installation command you look like this:

[PHOTO]

During the installation, you will be asked about your database credentials and the CLI you will generated the proper Data API code for you (magic!)

Once the Backend API is installed on your local machine, go into your new project, install the needed packages with npm i and type the following command in your terminal:

npm run dev

Your Data API will be started and your dashboard will automatically appear in your browser.

Et voilà, it's that simple!