Welcome to platformatic-starter 👋

platformatic quick start demo app

✨ Demo

Prerequisites

• Node.js >= v18.17.0 or >= v20.8.0

Install

pnpm install

Usage

pnpm run dev

Microservices

Platformatic Service in public beta.

pnpm run service

Deployment

This template comes with two GitHub Actions that handle automatically deploying your app to production environment.

Prior to your first deployment, you'll need to do a few things:

• Install Fly

• Sign up and log in to Fly

  fly auth signup
  

• Create a new app on Fly:

  fly apps create platformatic-starter
  

• Create a new GitHub Repository

• Add a FLY_API_TOKEN to your GitHub repo. To do this, go to your user settings on Fly and create a new token, then add it to your repo secrets with the name FLY_API_TOKEN.

• Create a persistent volume for the sqlite database for your app. Run the following:

  fly volumes create data --size 1 --app platformatic-starter
  

Now that every is set up you can commit and push your changes to your repo. Every commit to your main branch will trigger a deployment to your production environment.

GitHub Actions

We use GitHub Actions for continuous integration and deployment. Anything that gets into the main branch will be deployed to production after running tests/build/etc.

Pre-commit

This project uses pre-commit to run checks before committing your code. To install it, run:

pre-commit install

Useful references

• Quick Start Guide
• Movie Quotes App Tutorial
• Add Custom Functionality
• Deploy to Fly.io
• GraphQL subscriptions & microservice
• Platformatic v0.7.0 - New dashboard for Platformatic DB

Author

👤 Dung Huynh

• Website: https://productsway.com/
• Twitter: @jellydn
• Github: @jellydn

Show your support

Give a ⭐️ if this project helped you!