Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mcollina/plt-db-ts-no-schema
https://github.com/mcollina/plt-db-ts-no-schema
Last synced: 28 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/mcollina/plt-db-ts-no-schema
- Owner: mcollina
- Created: 2023-11-15T10:27:59.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-15T10:30:14.000Z (about 1 year ago)
- Last Synced: 2024-12-17T15:43:16.360Z (about 1 month ago)
- Language: TypeScript
- Size: 3.91 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://docs.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/) >= v18.8.0 or >= v20.6.0## Setup
1. Install dependencies:
```bash
npm install
```2. Apply migrations:
```bash
npm run migrate
```## 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