platformatic sample

Author: Chrisyhjiang

samples/platformatic/README.md

@@ -0,0 +1,32 @@
+# Platformatic App
+
+This sample project demonstrates how to deploy a simplist Platformatic service that returns "Platformatic x Defang" when accessed. The project includes a Dockerized setup with Docker Compose, making it easy to deploy and manage the service.
+
+Once your app is up and running, you can access it via the defined port (default is 3042). This service is designed to be simple, showcasing how to set up a basic Platformatic application and deploy it using Docker.
+
+## Prerequisites
+
+1. Download <a href="https://github.com/defang-io/defang">Defang CLI</a>
+2. (optional) If you are using <a href="https://docs.defang.io/docs/concepts/defang-byoc">Defang BYOC</a>, make sure you have properly <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html">authenticated your AWS account</a>.
+
+## Deploying
+
+1. Open the terminal and type `defang login`
+2. Navigate to the directory "app" with `cd ./app`
+3. Type `defang compose up` in the CLI.
+4. Your app will be running within a few minutes.
+
+## Local Development
+
+1. After cloning the repository and navigating to the root directory of the project, navigate to the directory called "app" with `cd app`
+2. Run `docker compose -f compose.dev.yaml up --build`
+
+---
+
+Title: Platformatic
+
+Short Description: A sample project showcasing a simple Platformatic service with Docker deployment.
+
+Tags: Platformatic, Defang, Docker, Node.js, Service, JavaScript
+
+Languages: nodejs

samples/platformatic/app/README.md

@@ -1,32 +1,32 @@
-# Platformatic Runtime API
+# Platformatic App
 
-This is a generated [Platformatic Runtime](https://docs.platformatic.dev/docs/runtime/overview) application.
+This sample project demonstrates how to deploy a simplist Platformatic service that returns "Platformatic x Defang" when accessed. The project includes a Dockerized setup with Docker Compose, making it easy to deploy and manage the service.
 
-## Requirements
+Once your app is up and running, you can access it via the defined port (default is 3042). This service is designed to be simple, showcasing how to set up a basic Platformatic application and deploy it using Docker.
 
-Platformatic supports macOS, Linux and Windows ([WSL](https://docs.microsoft.com/windows/wsl/) recommended).
-You'll need to have [Node.js](https://nodejs.org/) >= v18.8.0 or >= v20.6.0
+## Prerequisites
 
-## Setup
+1. Download <a href="https://github.com/defang-io/defang">Defang CLI</a>
+2. (optional) If you are using <a href="https://docs.defang.io/docs/concepts/defang-byoc">Defang BYOC</a>, make sure you have properly <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html">authenticated your AWS account</a>.
 
-1. Install dependencies:
+## Deploying
 
-```bash
-npm install
-```
+1. Open the terminal and type `defang login`
+2. Navigate to the directory "app" with `cd ./app`
+3. Type `defang compose up` in the CLI.
+4. Your app will be running within a few minutes.
 
-## Usage
+## Local Development
 
-Run the API with:
+1. After cloning the repository and navigating to the root directory of the project, navigate to the directory called "app" with `cd app`
+2. Run `docker compose -f compose.dev.yaml up --build`
 
-```bash
-npm start
-```
+---
 
-## Adding a Service
+Title: Platformatic
 
-Adding a new service to this project is as simple as running `create-platformatic` again, like so:
+Short Description: A sample project showcasing a simple Platformatic service with Docker deployment.
 
-```
-npx create-platformatic
-```
+Tags: Platformatic, Defang, Docker, Node.js, Service, JavaScript
+
+Languages: nodejs

samples/platformatic/app/compose.dev.yaml

@@ -0,0 +1,13 @@
+services:
+  platformatic-app:
+    build:
+      context: .
+    ports:
+      - "3042:3042"
+    environment:
+      NODE_ENV: development
+    restart: unless-stopped
+    volumes:
+      - .:/app
+      - /app/node_modules
+    command: npm run start

samples/platformatic/app/compose.yaml

@@ -1,6 +1,7 @@
 services:
   platformatic-app:
-    build: .
+    build:
+      context: .
     ports:
       - target: 3042
         published: 3042
@@ -9,6 +10,8 @@ services:
     environment:
       NODE_ENV: production
     restart: always
-    volumes:
-      - .:/app
-      - /app/node_modules
+    deploy:
+      resources:
+        limits:
+          cpus: "0.5"
+          memory: "512M"

samples/platformatic/app/platformatic.json

@@ -5,16 +5,14 @@
   "hotReload": true,
   "autoload": {
     "path": "services",
-    "exclude": [
-      "docs"
-    ]
+    "exclude": ["docs"]
   },
   "server": {
-    "hostname": "{PLT_SERVER_HOSTNAME}",
+    "hostname": "0.0.0.0",
     "port": "{PORT}",
     "logger": {
       "level": "{PLT_SERVER_LOGGER_LEVEL}"
     }
   },
   "managementApi": "{PLT_MANAGEMENT_API}"
-}
+}