README.md

Example: Tasks API

This example application was created for the guide 'Building REST APIs with Platformatic DB'.

Requirements

Platformatic supports macOS, Linux and Windows (WSL recommended). You'll need to have Node.js >= v16.17.0 or >= v18.8.0

Setup

1. Install dependencies:

npm install

2. Apply migrations:

npx platformatic db migrations apply

3. Seed the database:

npx platformatic db seed seed.js

Usage

Run the API with:

npm start

Explore

• ⚡ The Platformatic DB server is running at http://localhost:3042/
• 📔 View the REST API's Swagger documentation at http://localhost:3042/documentation/
• 🔍 Try out the GraphiQL web UI at http://localhost:3042/graphiql