Introduction to Deployd

Deployd is a powerful, open-source platform designed to simplify the back-end development process for web and mobile applications. With Deployd, developers can quickly set up APIs, manage databases, and handle user authentication without having to write extensive server-side code. This guide introduces you to the basics of Deployd and provides a comprehensive overview of its diverse API functionalities. We’ll also walk you through a complete example application leveraging these APIs.

Basic CRUD Operations

Create

Creating a new record in the database is simple with the Deployd API. You can use the following code snippet to add a new user:

  POST /users
  {
    "username": "john_doe",
    "password": "securepassword"
  }

Read

Fetching data from the database can be done using the GET method. Here is an example of retrieving user information:

  GET /users/john_doe

Update

Updating existing records is straightforward. Use the PUT method to update user information:

  PUT /users/john_doe
  {
    "password": "newsecurepassword"
  }

Delete

To delete a user record from the database, you can use the DELETE method:

  DELETE /users/john_doe

Advanced API Functionalities

Custom Endpoints

Deployd allows you to create custom endpoints using the `dpd` object. Here is how you can define a custom endpoint:

  dpd.customEndpoint.post({
    message: "Hello, World!"
  }, function(result, xhr) {
    console.log(result);
  });

User Authentication

Handling user login and logout operations is essential for most applications. Here are examples of login and logout endpoints:

  POST /users/login
  {
    "username": "john_doe",
    "password": "securepassword"
  }

  POST /users/logout

File Uploads

Deployd supports file uploads, making it convenient to handle media within your application:

  POST /files
  {
    "file": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
  }

Example Application

Now that we have covered the various APIs, let’s build a simple application that demonstrates CRUD operations and user authentication:

Server-Side Setup

  dpd.users.post({
    username: "alice",
    password: "password123"
  }, function(result, context) {
    console.log('User created:', result);
  });

  dpd.users.get({ username: "alice" }, function(users) {
    console.log('User fetched:', users);
  });

  dpd.users.put({ username: "alice" }, { password: "newpassword" }, function(result) {
    console.log('User updated:', result);
  });

Client-Side Integration

  <script src="http://localhost:2403/dpd.js"></script>
  <script>
    dpd.users.post({
      username: "alice",
      password: "password123"
    }, function(result) {
      console.log("User created:", result);
    });

    dpd.users.get({}, function(users) {
      console.log("Users fetched:", users);
    });

    dpd.users.put(result.id, { password: "newpassword" }, function(result) {
      console.log("User updated:", result);
    });
  </script>

This simple application demonstrates how quickly you can manage user data using Deployd’s APIs.

Hash: a5731f0acf0b608166c92a5e3248b26ecb2169c59ee925336bcdb0f3e5c8ab32