Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mcollina/platformatic-zod-test
https://github.com/mcollina/platformatic-zod-test
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/mcollina/platformatic-zod-test
- Owner: mcollina
- License: mit
- Created: 2023-07-26T09:49:07.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-26T10:03:40.000Z (over 1 year ago)
- Last Synced: 2024-12-17T15:43:16.328Z (23 days ago)
- Language: TypeScript
- Size: 4.88 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Platformatic Service API
This is a generated [Platformatic Service](https://docs.platformatic.dev/docs/reference/service/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
## Setup
Install dependencies:
```bash
npm install
```
## 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