DummyPod

An implementation of DummyJSON in Serverpod.

Directories

Main directories:

• Endpoints: This is where the endpoints are defined.
• Models: This is where the models are defined.
• Flutter App Lib: The lib directory of the Flutter app used to test endpoints.

Server-related commands

Run these commands from the apps/dummypod_server directory.

Running the server

docker compose up --build --detach
dart bin/main.dart --apply-migrations

After modifying an endpoint

serverpod generate

After modifying a model

serverpod generate

If the modification affects how the database is structured, you need to create and apply the migration:

serverpod create-migration
dart run bin/main.dart --role maintenance --apply-migrations

APIs

Auth

• Login and get token (handled by serverpod_auth)
• Get auth user (handled by serverpod_auth)
• Refresh token (handled by serverpod_auth)

Products

• Get all products
• Get a single product
• Search products
• Limit & skip products
• Get all products categories
• Get products of category
• Add a product
• Update a product
• Delete a product

Carts

• Get all carts
• Get a single cart
• Get carts of user
• Add a cart
• Update a cart
• Delete a cart

Recipes

• Get all recipes
• Get a single recipe
• Search recipes
• Limit & skip recipes
• Get all recipes tags
• Get recipes by tag
• Get recipes by meal type

Users

• Get all users
• Get auth user (handled by serverpod_auth)
• Get a single user
• Search users
• Filter users
• Limit & skip users
• Get user's carts
• Get user's posts
• Get user's todos
• Add a user
• Update a user
• Delete a user

Posts

• Get all posts
• Get a single post
• Search posts
• Limit & skip posts
• Get post by user id
• Get post's comments
• Add a post
• Update a post
• Delete a post

Comments

• Get all comments
• Get a single comment
• Limit & skip comments
• Get comment by post id
• Get post's comments
• Add a comment
• Update a comment
• Delete a comment

Image

• Generate square image
• Custom width/height
• Custom text
• Custom background color
• Custom text color
• Different formats
• Custom font family
• Custom font size

Todos

• Get all todos
• Get a single todo
• Get a random todo
• Limit & skip todos
• Add a todo
• Update a todo
• Delete a todo

Quotes

• Get all quotes
• Get a single quote
• Get a random quote
• Limit & skip quotes