https://github.com/mcollina/plt-db-websocket-test

https://github.com/mcollina/plt-db-websocket-test

Last synced: 28 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/mcollina/plt-db-websocket-test
• Owner: mcollina
• Created: 2023-04-18T09:36:36.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-04-18T09:56:34.000Z (almost 2 years ago)
• Last Synced: 2024-12-17T15:43:02.735Z (about 1 month ago)
• Language: JavaScript
• Size: 5.86 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Platformatic DB API

This is a generated [Platformatic DB](https://oss.platformatic.dev/docs/reference/db/introduction) application.

## Requirements

Platformatic supports macOS, Linux and Windows ([WSL](https://docs.microsoft.com/windows/wsl/) recommended).

You'll need to have [Node.js](https://nodejs.org/) >= v16.17.0 or >= v18.8.0

## Setup 

1. Install dependencies:

```bash

npm install

```

2. Apply migrations:

```bash

npx platformatic db migrations apply

```

## Usage

Run the API with:

```bash

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