​
Installation guideline

  1. Create an account at Retool or request an invite to the existing project. At the moment Retool doesn’t allow users to have multiple projects. So keep in mind that it’s impossible to use one account on different projects.

  2. Import prebuilt applications from retool folder in Ship. Open Apps > Create New > From JSON and choose needed.

  1. Attach resources (API or Database) for performing Retool queries: СRUD operations with data, HTTP requests, etc. Select the query, click on Resource and choose one. Look at the App Resources section to see how to connect different types of resources.

Learn how to build more with Retool documentation.

​
Predefined Apps

​
Users Management App

The application is built for user administration, it can be extended and used as internal admin panel. The main features are:

  • Users are displayed in the table.
  • You can find a particular user.
  • You can see the user’s details and apply a set of actions to the user. Default actions are: Update, Remove, Verify Email.

Add REST API

​
App Resources

This section helps you to connect the resources that are used by predefined Retool apps.

​
REST API

To connect API service:

  1. Select REST API resource
  2. Give a name to the resource
  3. Write Base URL of your server. For local development you need to tunnel the traffic.
  4. Add x-admin-key header. The value for x-admin-key is stored in config environments as adminKey.

​
MongoDB

To connect MongoDB service:

  1. Select MongoDB resource
  2. Give a name to the resource
  3. Select Use a database connection string. For local development you need to tunnel the traffic.
  4. Write Connection String of your database. The value for Connection String is stored in config environments as mongo.connection.

Learn how to use production and staging environments with Retool documentation.

​
Local development

For some of App Resources will need to tunnel your local traffic.

​
Tunnel http traffic

  1. Install ngrok
  2. Run ngrok http <your-api-port>

Link example: https://617c-93-125-14-163.ngrok.io

​
Tunnel mongo traffic

  1. Install ngrok
  2. Run ngrok tcp <your-mongodb-port>. You will see the forwarding link, for example tcp:/2.tcp.ngrok.io:19888.
  3. Paste generated route to mongodb://root:root@<generated-route>:19888/api-development?authSource=admin&replicaSet=rs&directConnection=true link.

Link example: mongodb://root:[email protected]:19888/api-development?authSource=admin&replicaSet=rs&directConnection=true

create-ship-appOverview